Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucas-erkana/codealpha_recipe_book
https://github.com/lucas-erkana/codealpha_recipe_book
Last synced: 5 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lucas-erkana/codealpha_recipe_book
- Owner: Lucas-Erkana
- License: mit
- Created: 2023-11-04T07:45:39.000Z (about 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-12-08T06:35:26.000Z (11 months ago)
- Last Synced: 2024-10-12T09:49:11.767Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://code-alpha-recipe-book.vercel.app/
- Size: 399 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Recipe Book🍽️
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 Recipe Book ](#-jabout-project-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Presentaton Link ](#-presentaton-link-)
- [🚀 Live Demo ](#-live-video-)
- [🚀 Project Details](#-project-details)
- [👥 Team](#--team)
- [🚀 Code Review link](#-code-review-link)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites ](#prerequisites-)
- [Setup](#setup)
- [Clone Git Repository](#clone-git-repository)
- [Install Dependencies](#install-dependencies)
- [Deployment ](#deployment-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)
> Recipe Book is an innovative platform that allows food enthusiasts and home cooks to share and organize their favorite recipes. Built with Node.js, Express, and MongoDB, the application offers robust functionality for creating, editing, and deleting recipes. Users can seamlessly add their cherished recipes with various details such as ingredients, preparation instructions, and even associate images. The clean, intuitive interface, powered by EJS, provides a user-friendly experience, making recipe management an absolute breeze. Dive into the culinary world and keep all your treasured recipes at your fingertips with Recipe Book - your trusted partner in the kitchen!
> In this project, a website for
## 🛠 Built With
- HTML
- CSS
- Javascript
- Express
- Mongodb
HTML
CSS
JavaScript
Express.js
MongoDB
EJS
Nodemon
Dotenv
- **User Authentication**: Registered users can log in to have their own personal recipe collection.
- **Recipe Submission**: Users can add new recipes with details such as ingredients, instructions, and an optional image.
- **Recipe Customization**: Users have the ability to edit their submitted recipes.
- **Recipe Collection**: Users can view all their recipes in one place, neatly organized for easy access.
- **Search and Filter**: Users can search for a specific recipe or filter recipes based on specific criteria.
- **Recipe Deletion**: Users can remove any recipes they no longer want from their collection.
## 🚀 Project Details
To get a local copy up and running follow these simple example steps.
In order to run this project you need:
- [x] You need to have **nodejs** installed.
- [x] You need to have a browser like **Google Chrome** installed.
- [x] You need to have **git** installed
- [x] You to have a code editor like **VS Code** or any other code-editors installed on you device.
- [x] **MongoDB**: As your project uses MongoDB as the database, users should have it installed and running on their systems.
- [x] **npm or yarn**: These are Node.js package managers used to manage project dependencies. It's important to mention the one you are using in your project.
- [x] **Internet Connection**: To download the necessary modules for your project and to connect with the database if it's hosted in the cloud.
- [x] **Dotenv**: Users should create a `.env` file in the root of your project to store environment variables such as database connection info.
### Setup
### Clone Git Repository
- In Visual Studio Code “Terminal” change the current working directory to the location where you want the cloned directory.
- Type git clone in the terminal, paste the URL you copied earlier, and press “enter” to create your local clone.
```
- git clone URL
https://github.com/Lucas-Erkana/CodeAlpha_Recipe_Book.git
```
### Install Dependencies
```sh
npm install
```
You can deploy this project locally using:
```sh
npm devstart
```
👤 **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)
- [ ] **User Profiles**: Include user profile customization where users can upload avatars, set usernames, and share a bit about themselves.
- [ ] **Social Sharing**: Allow users to share their recipes on social media or via email.
- [ ] **Comments and Reviews**: Allow users to comment on and review recipes.
- [ ] **Recipe Rating System**: Implement a star rating system for recipes.
- [ ] **Recipe Variations**: Enable users to submit variations of existing recipes.
- [ ] **Shopping List**: Allow users to add ingredients from recipes to a shopping list feature.
- [ ] **Ingredient Substitutions**: Suggest common ingredient substitutions within each recipe.
- [ ] **Nutrition Information**: Provide nutritional details for each recipe.
- [ ] **Mobile App**: Develop a mobile app version for a better user experience on mobile devices.
- [ ] **Cooking Mode**: Include a kitchen-friendly view that makes it easy to see a recipe from a distance, step-by-step cooking instructions, and timers.
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Lucas-Erkana/CodeAlpha_Recipe_Book/issues).
Please give a ⭐️ if you like this project! 🤝
- A special thanks to [Web Dev Simplified](https://courses.webdevsimplified.com/). Kyle's resources provided invaluable knowledge and guidance for this project. His teachings played a significant role in the completion of this project. Feel free to reach him at [email protected].
- **How can I add new recipes to the Recipe Book?**
After logging into your account, go to the "Add Recipe" feature and fill out the form with the details of your recipe - including ingredients, preparation steps, cooking time, and an optional image. Once you're satisfied, hit the "Submit" button, and the new recipe will be added to your collection.
This project is [MIT](./LICENSE) licensed.