Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 1.06 KB

README.md

File metadata and controls

44 lines (26 loc) · 1.06 KB
Raw

Koyofea Backend

Koyofea is a recruitment and hiring platform.

To Do

  • Docker-ize Koyofea (add dockerfile, etc).
  • Add boilerplate code.
  • Add boilerplate code documentation.

Getting Started

  1. Clone this repository.

git clone https://github.com/ankit16-19/koyofea-backend.git

  1. 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

  1. Optionally, set the NODE_ENV environment variable equal to development.

Windows: set NODE_ENV=development

Linux: export NODE_ENV=development

  1. 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

Further Reading

  • API.md: API instructions. Includes detailed info on routes and their use.
  • CONTRIBUTING.md: Instructions on how to contribute to Koyofea.