Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 1.79 KB

README.md

File metadata and controls

33 lines (27 loc) · 1.79 KB

codedamn.com

This is the official repository of codedamn.com, i.e. the contents you see on codedamn.com are directly fetched from the master branch of this repo. Feel free to contribute! We appreciate contributions from the community!

How codedamn is built

codedamn is built on the top of Node v8.9, Express Framework, MongoDB, Mongoose and TypeScript

How To Contribute?

Cloning the project

  1. Fork this repo
  2. Run git clone https://github.com/<YOUR_NICK>/codedamn.com
  3. Create secrets.ts file in the root directory (i.e. with index.ts file)
  4. Paste the following contents in it:
export const reCAPTCHAsecret = "SOME_RANDOM_KEY"
  1. Run npm i in the folder
  2. This project uses debug module. To show all debug messages, in your terminal, write: export DEBUG="cd:*" and hit enter.
  3. Make sure to start your mongodb server by writing sudo mongod in your terminal if your mongodb server is not running. (Check by writing mongo in terminal, if you get mongo shell, then your mongodb is running)
  4. I recommend using Robo3T Mongo Client for GUI working with DB.
  5. Once everything is done, run nodemon command which will pick up configs from supplied nodemon.json file and setup live reloading for .ts code.

Instructions

  1. The site uses TypeScript to enforce proper JavaScript code. Give it a look if you need an intro to TypeScript
  2. Please make sure your pull request is compatible with the flow and code structure of the overall site.
  3. Use tabs and not spaces :)
  4. Use curly brace on the same line like function damnit() { :)

Pull Requests Needed

Please check the issues tab for available things you can work on and be a contributor to codedamn.com!

Cheers! </>