Hot Takes is an API created by PIIQUANTE for sauce lovers. It contains a collection of detailed sauces added by our users, that you can like or dislike. This project forms part of the Openclassrooms course for web development and focuses on creating an API REST which is secure and in accordance with regulations.
Node.js, version: 16.15.0 LTS or later
npm version 8.9.0 or later
MongoDB
API client e.g. POSTMAN
Clone this repository and open it in your code editor. From the root project directory, run npm install then nodemon server, the server will run on port 3000 (default).
Create .env file in the root directory, then copy/paste the content of the .dot.exemple file. Set your own values to the environment variables that it contains.
The API works with MongoDB NoSQL database : If needed, sign up as indicated on the MongoDB website and get your SRV address. Paste it to the MONGO_URI value in .env file in order to connect to the database: don't forget to replace PASSWORD by your own one.
You can test this API with an API client, like POSTMAN or Thunder client which is the VSCode extension. The documentation is available here. The following extra routes were developed that are not accessible by the Frontend yet:
| name | method | URI | description |
|---|---|---|---|
| readUser | GET | /api/auth/ | returns user's data |
| exportData | GET | /api/auth/export/ | prints user's data to a txt document |
| updateUser | PUT | /api/auth/ | updates user's data |
| deleteUser | DELETE | /api/auth/ | deletes all user's data |
| reportUser | POST | /api/auth/:id/report/ | reports abusive content for a user id given. |
| reportSauce | POST | /api/sauces/:id/report/ | reports abusive content for a sauce id given. |
Those routes are only accessible to a logged-in user (a token is required) and, except the report routes, the owner of the profile.
The frontend part of the project can be retrieved from this repository. Add it to your workspace, open new terminal, then from Web-Developer-P6 directory execute :
- npm install
- npm start
The project will run on http://localhost:4200.