lucas-erkana / api_template

Recipe Website API - Culinary Delights at Your Fingertips 🍲

📗 Table of Contents

• 📗 Table of Contents
• About the Recipe Website API 🍳
  • Live Demo
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
  • To get a local copy up and running, follow these steps.
    • Prerequisites
    • Setup
    • Install
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 🙏 FAQ
  • 📝 License

About the Recipe Website API 🍳

This project is a comprehensive backend solution for managing and sharing culinary recipes. Designed with simplicity and efficiency in mind, it provides robust APIs for user authentication, recipe creation, and management. Whether you're a hobbyist cook or a professional chef, this API helps organize and share your culinary creations with ease.

Note: This project was meticulously crafted by Lucas Erkana, showcasing a blend of technical expertise and passion for culinary arts.

API Screenshot

Live Demo

To see this project's live demo, please click here.

🛠 Built With

This API was developed using the following technologies:

• Node.js
• Express
• MongoDB
• Mongoose
• JavaScript
• Postman

Tech Stack

Server

• Node.js
• Express
• MongoDB
• Mongoose

Key Features

• User authentication and registration.
• CRUD operations for recipes.
• Filtering and sorting recipes.
• Image upload and management for recipes.
• Nutritional information tracking.
• User role management (e.g., admin, editor, user).
• Responsive and intuitive API endpoints.
• Secure data handling and storage.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Node.js installed on your machine
• A MongoDB database
• A code editor such as Visual Studio Code

(back to top)

### Setup

To set up the Recipe Website API project, follow the steps below:

1. Clone this repository to your desired folder:

 git clone https://github.com/Lucas-Erkana/recipe_website.git

2. Navigate into the cloned folder:

 cd recipe_website

3.Install the necessary dependencies:

 npm install

4.Set up your environment variables in a .env file based on the .env.example provided.

MONGO_URL = mongodb+srv://recipebookwebsite:[email protected]/?retryWrites=true&w=majority

5.Start the server:

 npm start

(back to top)

Sure, here's how you can include the "Usage" section in your README.md file to guide users on how to use your Recipe Website API through Postman:

---

💻 Usage

After starting the server with npm start, you can use Postman to interact with the API. If you don't have Postman installed, you can use it directly in your browser here.

To CREATE a User:

1. Set the request type to POST.
2. Enter the URL: http://localhost:3000/users.
3. Click on Body, then select raw and choose JSON.
4. Add the following user details in the request body:

   {
       "username": "john",
       "email": "[email protected]",
       "role": "user",
       "password": "1234567"
   }

5. Click Send.

To READ Users:

• To fetch all users:

  1. Set the request type to GET.
  2. Enter the URL: http://localhost:3000/users.
  3. Click Send.

• To fetch a specific user:

  1. Set the request type to GET.
  2. Enter the URL: http://localhost:3000/users/[user-id] (replace [user-id] with the actual user ID).
  3. Click Send.

To UPDATE a User:

1. Set the request type to PUT.
2. Enter the URL: http://localhost:3000/users/[user-id] (replace [user-id] with the user ID you want to update).
3. In the Body section, select raw and choose JSON.
4. Add the updated user details. For example:

   {
       "username": "johndoe"
   }

5. Click Send.

To DELETE a User:

1. Set the request type to DELETE.
2. Enter the URL: http://localhost:3000/users/[user-id] (replace [user-id] with the user ID you want to delete).
3. Click Send.

(back to top)

👥 Authors

👤 Lucas Erkana

• GitHub: @Lucask-Erkana
• Twitter: @Lucas_David_22
• LinkedIn: Lucas Erkana
• Frontend Mentor - @Lucask-Erkana

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, please leave a ⭐️

(back to top)

🙏 Acknowledgments

• I would like to express my heartfelt gratitude to BAG for providing me with the opportunity to complete this task. Their support and encouragement have been invaluable throughout the development process.

(back to top)

📝 License

This project is MIT licensed.

(back to top)