- Docker-ize Koyofea (add dockerfile, etc).
- Add boilerplate code.
- Add boilerplate code documentation.
- Clone this repository.
git clone https://github.com/ankit16-19/koyofea-backend.git
- Install the dependencies (including dev dependencies).
npm install
- Make sure you install the developer dependencies if you intend to tinker with the code.
npm install --only=dev
- Optionally, set the
NODE_ENV
environment variable equal todevelopment
.
Windows: set NODE_ENV=development
Linux: export NODE_ENV=development
- Start the server.
npm start
If you successfully complete all the steps above, you'll see the following message in the console.
Express server listening on port 1619.
Environment: development
- API.md: API instructions. Includes detailed info on routes and their use.
- CONTRIBUTING.md: Instructions on how to contribute to Koyofea.