REST API for the RateIT project - interactive platform for sharing cars and motorcycles reviews.
- After cloning the repository install dependencies with the command
npm install
/yarn install
- Create
.env
file in the main directory - Create MongoDB cluster and database.
- Add your database address to the .env file as
MONGO_URI=<yourDBaddress>
- Add SendInBlue API key to the .env file as
SI_APIKEY=<yourSendInBlueAPIaddress>
- Add SendInBlue email address to the .env file as
SI_EMAIL=<yourSendInBlueEmailAddress
- Add JWT secret key (it's up to your personal choice) to the .env file as
JWT_SECRET=<yourJWTsecretKey>
- Type in
npm start
to run the server - Additionally, you may use command
npm test
for testing issues, but you will also have to add additional values to the .env file
This API currently uses 3 main routes, for managing users, cars and motorbikes.
Documentation for the routes can be found here