This is the backend application for So-yummy App, a website for cooking and recipe management. It provides the necessary server-side functionality to support the frontend application.
- Node.js and Express.js for server-side JavaScript runtime and web framework.
- MongoDB for the database to store recipes, user information, and other data.
- Mongoose as the MongoDB object modeling tool.
- Swagger UI Express for documenting and visualizing the API using Swagger documentation.
- Other dependencies such as axios, bcryptjs, cloudinary, cors, dotenv, joi, jsonwebtoken, morgan, multer, multer-storage-cloudinary, nanoid, nodemailer, and query-string are used for various functionalities within the backend.
For detailed API documentation, you can visit the Swagger UI documentation provided by the backend. It provides an interactive interface to explore and test the available API endpoints.
-
Clone the repository from GitHub:
git clone https://github.com/lisitsyna-anna/so-yummy-backend
-
Navigate to the project directory:
cd so-yummy-backend
-
Install the dependencies:
npm install
-
Configure environment variables by creating a .env file in the root of the project and providing the necessary values. Refer to the .env.example file for the required variables.
-
Start the development server:
npm run start:dev
-
This will start the backend server on the specified port (default is 3000) and establish a connection to the MongoDB database.
-
Access the backend APIs using the base URL http://localhost:3000 (or the specified port).
The development of this project was led by:
- Bohdan Orlovskiy - Team lead & Fullstack developer
- Olya Zamlynska - Scrum master & Fullstack developer
- Anna Lisitsyna - Fullstack developer
- Mykola Zaikovskyi - Fullstack developer
- Nelia Bochenkova - Fullstack developer
If you have any questions or feedback, please feel free to contact me:
- Email: [email protected]
- GitHub: lisitsyna-anna