Skip to content

Latest commit

 

History

History
190 lines (117 loc) · 5.74 KB

README.md

File metadata and controls

190 lines (117 loc) · 5.74 KB

Four Flavors Express

Welcome to Four Flavors Express, your go-to food delivery platform that brings the best flavors from your favorite restaurants straight to your doorstep. Whether you’re craving local street food, gourmet dishes, or international cuisine, we’ve got you covered.
🌐 Website
Watch Demo: Demo
Visit us at: Four Flavors Express

📱 About Four Flavors Express

Four Flavors Express is designed to provide a seamless food ordering experience. We partner with a wide range of restaurants, ensuring you have access to diverse menus and delicious meals, all delivered fast and fresh.

Key Features

✅ Easy Restaurant Browsing
✅ Real-Time Order Tracking
✅ Secure Online Payments
✅ Personalized Recommendations
✅ Scheduled Deliveries

📦 Project Structure

This project follows a full-stack architecture with a React frontend and a Node.js/Express backend.

Four-Flavors-Express
├── backend/               # Backend (API, Database, Business Logic)
│   ├── config/             # Database connection, environment variables
│   ├── controllers/        # Business logic & request handling
│   ├── models/              # Database models (Mongoose/Sequelize)
│   ├── routes/              # API routes (endpoints)
│   ├── middlewares/         # Authentication, error handling, etc.
│   ├── utils/                # Helper functions (e.g., email service, etc.)
│   ├── app.js                # Main Express app
│   └── server.js             # Server entry point
│
├── frontend/               # Frontend (User Interface)
│   ├── public/              # Static assets (images, icons, etc.)
│   ├── src/                  # Main React source files
│   │   ├── assets/           # Images, fonts, etc.
│   │   ├── components/       # Reusable UI components
│   │   ├── pages/            # Pages (Home, Menu, Cart, Profile, etc.)
│   │   ├── services/         # API calls (Axios/Fetch)
│   │   ├── context/          # Global State (Context API)
│   │   ├── App.jsx            # Main App Component
│   │   ├── main.jsx           # React entry point
│   │   └── styles/            # CSS/SCSS files
│   ├── index.html             # Main HTML template
│   └── vite.config.js         # Vite Configuration (if using Vite)
│
│
├── docs/                 
│  └── README.md              # Documentation, screenshots, API specs
│
├── .env                      # Environment variables
├── .gitignore                 # Files to ignore in git
├── README.md                  # Project README file
├── package.json               # Project metadata (combined if monorepo)
├── LICENSE                    # License file
└── yarn.lock / package-lock.json   # Dependency lock file

📜 Project Structure Explanation

Folder/File Purpose
backend/ Houses all server-side logic (API, DB, authentication).
frontend/ Contains all client-side code (React UI).
mobile/ Optional - for mobile app development.
docs/ Contains diagrams, API documentation, and internal documentation.
.env Stores environment variables like DB URI and API keys.
README.md Provides an overview of the project.
package.json Lists dependencies and scripts.
.gitignore Specifies files and directories to be ignored by git.

🚀 Installation

If you want to run the app locally for development, follow these steps:
  1. Clone the repository:
git clone https://github.com/Web-Dev-Codi/Food-Delivery-Service-App
  1. Navigate to the project directory:
cd Food-Delivery-Service-App
  1. install dependencies:
npm install
  1. Start the development server
npm run dev

🏗️ Tech Stack

Component Technology
Frontend React / Next.js
Backend Node.js / Express
Database MongoDB
Payment Gateway Stripe
Deployment Render

📦 Features Under Development

  • 🎁 Loyalty Rewards Program
  • 💬 In-App Chat with Restaurants
  • 💸 Multi-Order Discounts
  • 🌙 Dark Mode for Night-Time Browsing

🌍 Team Members

🚀 Ashwini Bheemireddy

Responsibilities:

  • Frontend development using React and Tailwind CSS.

  • Designed logo, color scheme, and overall branding.

  • LinkedIn

🌟 Brian Cordisco

Responsibilities:

  • Managed GitHub repository and resolved merge conflicts.

  • Contributed to frontend and backend integration.

  • 📧 Email

🔥 Tabassum Khan

Responsibilities:

  • Team coordinator for backend-frontend development.

  • Worked on authentication, order management, and payment integration.

  • LinkedIn

⚡ Tuanthong Vaidyanond

Responsibilities:

  • Specialized in UI/UX design for responsive interfaces.

  • Optimized typography, forms, and navigation for better user interaction.

  • LinkedIn