malviyanshiv / code-band-backend

API for code-band

code-band-backend

This is a simple REST API developed using node and express with javascript.

Requirements

• Node and npm
• MongoDB

Getting Started

Installation

1. Clone the repo locally :

   git clone https://github.com/malviyanshiv/code-band-backend.git
   

2. Install dependencies :

   npm install
   

Run

1. Setup environment varaibles : Create configuration file config/dev.env and set variables

   PORT=3000
   MONGODB_URL=mongodb://127.0.0.1:27017/code-band-api
   JWT_SECRET=thisislocalkey
   

2. Run the server in dev mode

   npm run dev
   

Resources

• API Documentation

Contributing to API

We strongly encourage you to join us in contributing to this repository so everyone can benefit from :

• New features and functionality
• Resolved bug fixes and issues
• Any general improvements

Follow these simple steps

1. Fork it (https://github.com/malviyanshiv/code-band-backend)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar') Please make sure your commit should prefix your template name so that it can easily be tracked.
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Licence

MIT license. For more information, see the LICENSE file.