Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lucas-erkana/recipe_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.
https://github.com/lucas-erkana/recipe_api

Last synced: 5 days ago
JSON representation

Host: GitHub
URL: https://github.com/lucas-erkana/recipe_api
Owner: Lucas-Erkana
Created: 2023-12-04T09:01:11.000Z (12 months ago)
Default Branch: main
Last Pushed: 2023-12-04T11:03:27.000Z (12 months ago)
Last Synced: 2024-10-12T09:49:12.455Z (about 1 month ago)
Language: JavaScript
Homepage: https://recipe-api-teal.vercel.app
Size: 146 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Recipe Website API - Culinary Delights at Your Fingertips 🍲

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [About the Recipe Website API 🍳](#-about-project-)
- [Live Demo](#live-demo)
- [🛠 Built With](#-built-with-)
- [Tech Stack](#tech-stack-)
- [Key Features](#key-features-)
- [💻 Getting Started](#-getting-started-)
- [To get a local copy up and running, follow these steps.](#to-get-a-local-copy-up-and-running-follow-these-steps)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [👥 Authors](#-authors-)
- [🔭 Future Features](#-future-features-)
- [🤝 Contributing](#-contributing-)
- [⭐️ Show your support](#️-show-your-support-)
- [🙏 Acknowledgments](#-acknowledgments-)
- [🙏 FAQ](#-faq-)
- [📝 License](#-license-)

# About the Recipe Website API 🍳

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

### API Screenshot

![Recipe API](https://github.com/Lucas-Erkana/Recipe_API/assets/41428579/548917c2-0453-435e-871e-571d81f87790)

## Live Demo

To see this project's live demo, please click [here](https://famous-pear-rugby-shirt.cyclic.app/).

## 🛠 Built With

This API was developed using the following technologies:

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

### Tech Stack

Server

### 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:

```sh
git clone https://github.com/Lucas-Erkana/recipe_website.git
```
2. Navigate into the cloned folder:

```sh
cd recipe_website
```

3.Install the necessary dependencies:

```sh
npm install
```
4.Set up your environment variables in a .env file based on the .env.example provided.
```sh
MONGO_URL = mongodb+srv://lderkana21x:[email protected]/?retryWrites=true&w=majority
```
5.Start the server:
```sh
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 agent installed, you can use it directly in your browser [here](https://web.postman.co/workspace/My-Workspace~80c6c9a1-1856-44c4-8f45-dc93fabc7188/request/create?requestId=359ef886-fef6-46be-a481-46db2fe2b5e9).

### To CREATE:

Add 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:
```json
{
"username": "john",
"email": "[email protected]",
"role": "user",
"password": "1234567"
}
```
5. Click `Send`.

Add a Recipe

1. Set the request type to `POST`.
2. Enter the URL: `http://localhost:3000/recipes`.
3. Click on `Body`, then select `raw` and choose `JSON`.
4. Add the following recipe details in the request body:
```json
{
"nutritionalInfo": {
"calories": 350,
"fat": 15,
"protein": 25
},
"title": "Beef and Broccoli",
"description": "A savory and quick stir-fry dish combining tender strips of beef with fresh broccoli florets, served with a rich, garlic-infused sauce.",
"ingredients": [
"500g beef sirloin, thinly sliced,2 heads of broccoli, cut into florets,2 tbsp vegetable oil,3 cloves garlic, minced,1 tbsp ginger, grated,1/4 cup oyster sauce,2 tbsp soy sauce,1/2 cup beef broth,1 tsp cornstarch,1 tbsp water,Salt and pepper to taste"
],
"instructions": "Marinate beef in a mixture of soy sauce and cornstarch. Heat oil in a wok and stir-fry beef until browned. Remove beef and add broccoli, garlic, and ginger. Stir-fry until broccoli is tender. Return beef to the wok. Mix oyster sauce, beef broth, and cornstarch slurry, then add to the wok. Stir until the sauce thickens. Season with salt and pepper. Serve with rice or noodles.",
"prepTime": 15,
"cookTime": 10,
"servings": 5,
"cuisine": "Chinese",
"course": "Main",
"images": [
"https://omnivorescookbook.com/wp-content/uploads/2022/05/220503_Beef-And-Broccoli_550.jpg"
],
"author": "Chef John Doe",
"dateCreated": "2023-11-27T10:50:03.687Z",
"ratings": [
{
"rating": 5,
"review": "Delicious and easy to make!",
"_id": "6564dfebc0052d34336882fe"
},
{
"rating": 4,
"review": "Loved the flavors, though a bit too salty for my taste.",
"_id": "6564dfebc0052d34336882ff"
}
]
}
```
5. Click `Send`.

### To READ:

Read Users or Recipes

- To fetch all users or recipes:
1. Set the request type to `GET`.
2. Enter the URL: `http://localhost:3000/users` or `http://localhost:3000/recipes`.
3. Click `Send`.

- To fetch a specific user or recipe:
1. Set the request type to `GET`.
2. Enter the URL: `http://localhost:3000/users/[user-id]` or `http://localhost:3000/recipes/[recipe-id]`.
3. Click `Send`.

### To UPDATE:

Update a User

1. Set the request type to `PUT`.
2. For User: Enter the URL: `http://localhost:3000/users/[user-id]`.
3. In the `Body` section, select `raw` and choose `JSON`.
4. Add the updated user details. For example:
```json
{
"username": "johndoe"
}
```
5. Click `Send`.

Update a Recipe

1. Set the request type to `PUT`.
2. For User: Enter the URL: `http://localhost:3000/recipes/[recipe-id]`.
3. In the `Body` section, select `raw` and choose `JSON`.
4. Add the updated recipe details. For example:
```json
{
"title": "Beef and Broccoli Stir-Fry"
}
```
5. Click `Send`.

### To DELETE:

Delete a User

1. Set the request type to `DELETE`.
2. For User: Enter the URL: `http://localhost:3000/users/[user-id]`.
3. Click `Send`.

Delete a Recipe

1. Set the request type to `DELETE`.
2. For Recipe: Enter the URL: `http://localhost:3000/recipes/[recipe-id]`.
3. Click `Send`.

(back to top)

## 👥 Authors

👤 **Lucas Erkana**

- GitHub: [@Lucask-Erkana](https://github.com/Lucask-Erkana)
- Twitter: [@Lucas_David_22](https://twitter.com/@Lucas_David_22)
- LinkedIn: [Lucas Erkana](https://www.linkedin.com/in/lucas-erkana/)
- Frontend Mentor - [@Lucask-Erkana](https://www.frontendmentor.io/profile/Lucask-Erkana)

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Lucas-Erkana/API_template/issues).

(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](https://bag.wrk) 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](./LICENSE) licensed.

(back to top)