Recipe Realm

Table Of Contents

• Introduction

• Installation

• Features

• How-To-Use

• Contact

Introduction

Welcome to Recipe Realm, Discover the joy of cooking and community! Whether you're a culinary enthusiast or a beginner in the kitchen, Recipe Realm is your platform to explore, create, and share delectable recipes with like-minded individuals. Dive into a world where every dish tells a story and every user is part of a vibrant cooking community. Below is your guide to navigating Recipe Realm:

Installation

To download the dependencies for the backend server, run:

pipenv install

pipenv shell

You can run your Flask API on localhost:5555 by running:

python server/app.py

Check that your server serves the default route http://localhost:5555.

To download the dependencies for the frontend client, run:

npm install --prefix client

You can run your React app on localhost:3000 by running:

npm start --prefix client

Check that your the React client displays a default page http://localhost:3000.

Features

• Signup : New users can create an account to access the Recipe Realm platform.

• Login: Registered users can log in to manage their recipes, profile, and interact with other users.

• Logout: Users can securely log out of their accounts.

• Manage Recipes: Registered users can create, update, and delete their own recipes.

• View and Comment: Explore a variety of recipes shared by other users, and engage by leaving comments.

• Profile Management: Customize your profile with a picture, contact information, and an "About Me" section.

How-To-Use

1. Sign Up

• Create an account by providing necessary details such as username, and password.

2. Log In

• Enter your credentials to access your account and start using Recipe Realm.

3. Home Page

• Upon signing in, you'll land on the home page where you can browse recipes shared by the community.

4. View Recipes

• Explore a diverse selection of recipes created by other users.

5. Recipe Detail Page

• Click on any recipe to view its detailed information and comments made by other users.

6. Create A Recipe Of Your Own

• Met with a form that allows you to enter recipe Title, Descripton, Ingredients, Instructions, and Photo. Upon Pressing the "Add Recipe" Button you will see your recipe appear both on Home Page and Manage Page.

7. Manage Page

• Visit the Manage Page to edit or delete recipes you've created. This ensures you have full control over your content.

8. Profile Page

• Ability create Profile Picture, Email, Phone Number, and About Me.

9. Log Out

• Click the "Log Out" button to sign out of your account.

Contact

Pedro Alarcon | GitHub | LinkedIn