Skip to content

tisha-akter/crave-cart-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CraveCart - Online Food Ordering Web App

React Vite TailwindCSS DaisyUI

A modern, responsive food ordering platform built with React and Vite. Order your favorite meals from local restaurants with ease!

✨ Features

  • 🏪 Restaurant Discovery - Browse and search local restaurants
  • 🍔 Menu Browsing - View detailed menus with images and descriptions
  • 🛒 Shopping Cart - Add items and manage your order
  • 👤 User Authentication - Secure login and registration
  • 💳 Payment Integration - Secure online payments
  • 📱 Responsive Design - Works on all devices
  • Real-time Updates - Live order tracking
  • Reviews & Ratings - Customer feedback system
  • 🎨 Modern UI - Clean and intuitive interface

🚀 Quick Start

Prerequisites

  • Node.js 18+
  • npm or yarn

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/crave-cart-client.git
    cd crave-cart-client
  2. Install dependencies

    npm install
  3. Set up environment variables

    cp .env.example .env.local
    # Edit .env.local with your configuration
  4. Start development server

    npm run dev
  5. Open your browser

    http://localhost:5173
    

📁 Project Structure

crave-cart-client/
├── src/
│   ├── components/         # Reusable UI components
│   ├── pages/             # Route components
│   ├── hooks/             # Custom React hooks
│   ├── services/          # API services
│   ├── utils/             # Utility functions
│   ├── constants/         # App constants
│   ├── styles/            # CSS files
│   └── config/            # Configuration
├── docs/                  # Documentation
├── public/                # Static assets
└── tests/                 # Test files

📋 See FOLDER_STRUCTURE.md for detailed structure documentation.

🛠️ Built With

📜 Available Scripts

# Development
npm run dev          # Start development server
npm run build        # Build for production
npm run preview      # Preview production build
npm run lint         # Run ESLint

# Testing (when configured)
npm test             # Run tests
npm run test:watch   # Run tests in watch mode
npm run test:coverage # Run tests with coverage

🌍 Environment Variables

Create a .env.local file in the root directory:

# API Configuration
VITE_API_BASE_URL=http://localhost:3001/api

# Third-party Services
VITE_GOOGLE_MAPS_API_KEY=your_google_maps_api_key
VITE_STRIPE_PUBLIC_KEY=your_stripe_public_key

# Feature Flags
VITE_ENABLE_ANALYTICS=false

🚢 Deployment

Vercel (Recommended)

npm install -g vercel
vercel --prod

Netlify

npm run build
# Upload dist/ folder to Netlify

Docker

docker build -t crave-cart-client .
docker run -p 3000:3000 crave-cart-client

🧪 Testing

# Run all tests
npm test

# Run tests in watch mode
npm run test:watch

# Generate coverage report
npm run test:coverage

📚 Documentation

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

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

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👥 Team

  • Tisha Akter
  • Munim

Made with ❤️ for food lovers everywhere

⭐ Star this repo if you find it helpful!

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors