Taste-Tribe

Welcome to TasteTribe! Finding suitable recipes online can be challenging, especially when most accessible options are high-end meals that may not be appropriate for middle- or lower-income households. TasteTribe aims to address this issue by providing a platform for discovering and sharing simple, practical recipes that meet everyday needs. Our service gives you access to a variety of easy-to-make recipes, complete with ingredients, methods, and serving sizes. Additionally, registered users can enhance their experience by commenting, bookmarking, and rating recipes.

Table of Contents

• Project Overview
• Features
• Technology Stack
• Installation
• Team Members
• Contributing
• License

Project Overview

Problem Statement

Finding the right recipe online can be difficult, especially when most available recipes are for high-end or gourmet meals that may be out of reach. Individuals and families often struggle to find easy and quick-to-prepare meals that meet their daily needs. The lack of easily accessible, simple recipes exacerbates the situation, making it challenging for users to enjoy home-cooked meals without spending excessive time searching or deciphering complex cooking instructions.

Solution

TasteTribe addresses this problem by offering a dedicated platform for discovering and sharing simple, practical recipes. Our application provides a curated collection of recipes that include essential details such as ingredients, preparation procedures, and serving sizes. This ensures that users can quickly find recipes that are both manageable and affordable.

TasteTribe_2.0
├── 📄 Pipfile
├── 🔒 Pipfile.lock
├── 👁️ .gitignore
├── 📚 README.md
├── 🖥️ client
│   ├── 📚 README.md
│   ├── 👁️ .gitignore
│   ├── 🗃️ db.json
│   ├── 🧹 eslint.config.js
│   ├── 🌐 index.html
│   ├── 🔒 package-lock.json
│   ├── 📦 package.json
│   ├── 🎨 postcss.config.js
│   ├── 🌐 public
│   │   └── 🖼️ vite.svg
│   ├── 🧠 src
│   │   ├── 🎨 App.css
│   │   ├── ⚛️ App.jsx
│   │   ├── 🔌 api.jsx
│   │   ├── 🖼️ assets
│   │   │   └── ⚛️ react.svg
│   │   ├── 🧩 components
│   │   │   ├── 🔍 ExploreRecipes.jsx
│   │   │   ├── 🌟 FeaturedRecipes.jsx
│   │   │   ├── 🃏 FeaturedRecipesCard.jsx
│   │   │   ├── 👣 Footer.jsx
│   │   │   ├── 🧭 NavBar.jsx
│   │   │   └── 👤 UserRecipesCard.jsx
│   │   ├── 🎣 hooks
│   │   │   └── 🔐 useAuth.js
│   │   ├── 🎨 index.css
│   │   ├── 🚀 main.jsx
│   │   ├── 📄 pages
│   │   │   ├── 👥 AboutUs
│   │   │   │   └── AboutUs.jsx
│   │   │   ├── 👑 Admin
│   │   │   │   ├── AdminDashboard.jsx
│   │   │   │   └── AdminSignIn.jsx
│   │   │   ├── 📞 ContactUs
│   │   │   │   └── ContactUs.jsx
│   │   │   ├── ❌ ErrorPage
│   │   │   │   └── ErrorPage.jsx
│   │   │   ├── 🏠 Home
│   │   │   │   └── Home.jsx
│   │   │   ├── 🔑 LogIn
│   │   │   │   └── LogIn.jsx
│   │   │   ├── 🍽️ RecipeInfo
│   │   │   │   └── RecipeInfo.jsx
│   │   │   ├── 📖 Recipes
│   │   │   │   └── Recipes.jsx
│   │   │   ├── 📝 SignUp
│   │   │   │   └── SignUp.jsx
│   │   │   ├── 👤 UserProfile
│   │   │   │   └── UserProfile.jsx
│   │   │   └── 👨‍🍳 UserRecipes
│   │   │       └── UserRecipes.jsx
│   │   └── 🛣️ routes.jsx
│   ├── 🎨 tailwind.config.js
│   ├── 🚀 vercel.json
│   └── ⚙️ vite.config.js
└── 🖥️ server
    ├── 📄 Pipfile
    ├── 🔒 Pipfile.lock
    ├── 👁️ .gitignore
    ├── 🚀 app.py
    ├── ⚙️ config.py
    ├── 🗃️ db.json
    ├── 🦄 gunicorn_run.py
    ├── 📁 instance
    │   └── 🗄️ tastetribe.db
    ├── 🔄 migrations
    │   ├── 📚 README
    │   ├── ⚙️ alembic.ini
    │   ├── 🌿 env.py
    │   ├── 📜 script.py.mako
    │   └── 📂 versions
    │       └── 🔢 1ded27d83174_initial_migration.py
    ├── 🏗️ models.py
    ├── 📋 requirements.txt
    ├── 🛣️ routes
    │   ├── 👑 admin.py
    │   ├── 🔐 auth.py
    │   ├── 🔖 bookmarks.py
    │   ├── 💬 comments.py
    │   ├── 📞 contact.py
    │   ├── 👍 likes.py
    │   ├── 🔔 notifications.py
    │   ├── ⭐ ratings.py
    │   ├── 🍽️ recipes.py
    │   └── 👤 users.py
    ├── 📐 schema
    │   └── schema.py
    ├── 🔑 secret.py
    └── 🌱 seed.py

Features

MVP (Minimum Viable Product)

• User authentication (login and account creation)
• Profile management (view and update profile, including profile images stored on Cloudinary)
• Recipe browsing and search functionality (by name, ingredients, and number of people served)
• Advanced recipe filtering (by country, ratings, ingredients, number of people served, and creation date)
• Recipe management (create, update, and delete recipes)
• Recipe bookmarking/favoriting
• Social media sharing (Facebook, Twitter, and WhatsApp)

Technology Stack

Frontend

• React
• React Router for navigation
• React Icons for UI elements
• React Toastify for notifications
• Framer Motion for animations
• TailwindCSS for styling

Backend

• Flask (Python web framework)
• SQLAlchemy (ORM for database interactions)
• SQLite (Database)
• RESTful API architecture

Deployment

• Vercel (Frontend hosting)
• Render (Backend hosting)

Installation

Backend Setup

1. Clone the repository:

   git clone [email protected]:Nicolex0/TasteTribe_2.0.git

2. Navigate to the project directory:

   ```sh
   cd TasteTribe_2.0
   ```

3. Navigate to the server directory:

   ```sh
   cd server
   ```

4. Ensure you are using python v3.8.13 and install the packages for the project:

   ```sh
   pipenv --python 3.8.13
   ```

   then

   ```sh
   pipenv install
   ```

5. Activate the virtual environment:

   ```sh
   pipenv shell
   ```

6. Run the server:

   ```sh
   python app.py
   ```

   or

   ```sh
   gunicorn --config gunicorn_run.py app:app
   ```

### Frontend Setup

1. Open another terminal.

2. Navigate to the frontend directory:

   ```sh
   cd TasteTribe_2.0/client
   ```

3. Ensure you are using Node.js v20.16.0. Use the Node Version Manager (nvm):

   ```sh
   nvm use 20.16.0
   ```

4. Install the frontend dependencies:

   ```sh
   npm install
   ```

5. Run the application:

   ```sh
   npm run dev
   ```

## Team Members

- Nicole Apono
- Dennis Githaiga
- Joy Simiyu
- Tony Brian
- John-Alexander Kamau

## Contributing

1. Fork the repository.
2. Create your feature branch (`git checkout -b feature/your-feature`).
3. Commit your changes (`git commit -m 'Add some feature'`).
4. Push to the branch (`git push origin feature/your-feature`).
5. Open a pull request.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.