This is a list of needed steps to set up your project locally, to get a local copy up and running follow these instructions.
- Clone the repository
$ git clone https://github.com/Orange-Hackathon/Back-End.git
- Navigate to project folder and create file named ".env"
$ cd Backend & touch .env
- Fill ".env" file with these data
NODE_ENV=development
PORT=[PORT YOU WANT]
DATABASE=[CONNECTION STRING OF YOUR DATABASE]
DATABASE_PASSWORD=[YOUR DATABASE PASSWORD]
EMAIL_USERNAME=[YOUR EMAIL USERNAME]
EMAIL_PASSWORD=[EMAIL PASSWORD]
EMAIL_FROM=[YOUR EMAIL USERNAME] - Install Node js and NPM
Follow this article to install node js and npm Install Node js and npm
- Install dependencies
$ npm install
- Start the application
$ npm start
You can look on the API documentation at API Documentation
Ahmed Lotfy |
This software is licensed under MIT License, See License .