Food Recipes Rest API

Report Bug - Request Feature

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Related Project
• Contact

About The Project

Food Recipes Rest API is server api that used in Food Recipes application . This server manage all function and endpoint in Food recipes app such as create, add , update and delete recipe, Authentication about login, register, getting profile, and also comment recipe, like, bookmark recipe.

Built With

• Node JS
• Express JS
• Nodemailer Package
• Cloudinary
• Morgan Package
• DotEnv Package
• JWT Package
• Multer Package
• Argon2 Package
• XSS middleware
• Helmet middleware
• Etc.

Getting Started

Prerequisites

Before going to the installation stage there are some software that must be installed first.

• NodeJs V18.00^

Installation

1. Clone the repo

git clone https://github.com/matfaisall/recipe-backend.git

2. Go to repo

cd recipe-backend

3. Install NPM packages

npm install

4. Add .env file at root folder project, and add following

PORT=4000

DB_HOST=your_db_host
DB_PORT=your_db_port
DB_DATABASE=your_db_name
DB_USER=your_db_username
DB_PASSWORD=your_db_password

JWT_TOKEN=your_jwt_token

CLOUD_NAME=your_cloduinary_username
CLOUD_API_KEY=your_cloduinary_api_key
CLOUD_API_SECRET=your_cloduinary_api_secret

EMAIL_FOR_SENDEMAIL = email_for_sendemail_nodemailer
PASS_SEND_EMAIL = email_password_sendemail_nodemailer

5. Try it

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b your/branch)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/yourbranch)
5. Open a Pull Request on Github

Related Project

📚 Food Recipes Rest API 📚 Food Recipes Frontend 📚 Food Recipes Mobile

Contact

Contributors names and contact info

• AUTHOR

Muhammad Faisal Lead Frontend | Frontend Web Developer

[LinkedIn Account]