Welcome to the Recipe Sharing Platform! This project provides a space for users to share and explore unique recipes. With features like searching, submitting, and rating recipes, this platform allows users to connect, inspire, and create delicious meals together.
The Recipe Sharing Platform is a community-driven web application that allows users to:
- Discover new recipes.
- Share their own creations.
- Rate and comment on recipes submitted by others.
- Explore various categories of recipes, including vegetarian, vegan, gluten-free, and more.
- Save their favorite recipes for future reference.
This platform is built with user experience in mind, providing an intuitive interface for easy navigation, searching, and recipe management.
- Recipe Submission: Users can submit their recipes along with ingredients, instructions, and images.
- Recipe Rating & Reviews: Users can rate and comment on recipes to share their feedback.
- Search & Filter: Find recipes by ingredient, difficulty level, cuisine type, and more.
- User Profiles: Create an account to save favorite recipes and manage submitted recipes.
- Categories: Browse recipes by category such as breakfast, dinner, desserts, vegan, etc.
- Responsive Design: The platform is optimized for both desktop and mobile use.
-
Frontend:
- HTML, CSS, JavaScript
- React (for dynamic UI)
- Axios (for API requests)
- Bootstrap or Material-UI (for styling)
-
Backend:
- Node.js
- Express.js
- MongoDB (for database storage)
-
Authentication:
- JWT (JSON Web Tokens) for user authentication
-
Deployment:
- Heroku or Vercel (for deployment)
To run this project locally on your machine, follow the steps below.
Make sure you have the following installed:
- Node.js (v14 or higher)
- MongoDB (local or use MongoDB Atlas for cloud-based storage)
- Clone the repository to your local machine:
git clone https://github.com/Guten-Morgen1302/recipe-sharing-platform.git
cd recipe-sharing-platform
Install the dependencies:
npm install
Set up the backend by creating a .env file in the root directory and add the following environment variables:
MONGO_URI=<your-mongodb-uri>
JWT_SECRET=<your-jwt-secret-key>
Start the backend server:
npm run server
Start the frontend application:
npm run client
Open the app in your browser at http://localhost:3000.
Usage
Submit a Recipe: After logging in, click on the "Submit a Recipe" button, fill in the necessary details (recipe name, ingredients, instructions, and image), and submit your recipe.
Search for Recipes: Use the search bar to search for recipes by ingredients, cuisine, or category.
Rate & Comment on Recipes: After trying a recipe, leave a rating and comment to let others know what you think.
Save Favorite Recipes: Save your favorite recipes for quick access.
Contributing
We welcome contributions to improve the platform! If you’d like to contribute, follow these steps:
Fork the repository.
Create a new branch (git checkout -b feature-name).
Make your changes and commit them (git commit -m 'Add new feature').
Push your changes to your fork (git push origin feature-name).
Submit a pull request with a clear description of your changes.