Skip to content

AbdeljalilOuafi/Prime-Eats

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

✨ Prime Eats Platform — "Your Food, Your Way" 🍲✨

Welcome to Prime Eats! Our platform is a modern, community-driven application where restaurant owners and food enthusiasts can connect. From managing restaurant menus to tracking orders seamlessly, Prime Eats empowers restaurants and diners to enjoy a better experience.

Home page


Team Members


Features

🌍 Restaurant Search: Users can search for restaurants near their location with a single click by granting location access.

📍 Google Places API Integration: Fetch restaurant details such as name, address, photos and ratings directly from Google Places API.

📋 Static Menus: While menus are not provided by the API, users can explore static placeholder menus for demonstration purposes.

⚙️ Adaptable Codebase: The platform is designed to be easily extended to include restaurant and menu management, making it ready for real-life implementations.

💳 Payment Integration: Support for PayPal payments for potential use cases such as ordering food.

🔐 User Authentication: Secure user management implemented using Clerk.


Technologies Used

  • Backend Framework: Django REST Framework (DRF)
  • Frontend Framework: Vite React.js
  • HTTP Client Library: Axios
  • Styling: Tailwind CSS
  • Animation: Framer Motion
  • Authentication: Clerk (JWT-based authentication)
  • API Integration: Google Places API
  • Payment Gateway: PayPal
  • Database: PostgreSQL
  • Caching: Redis
  • Deployment: Google Cloud ( VM instance )
  • Testing: Django Tests (Backend)
  • CI/CD: GitHub Actions
  • Email Service: Resend
  • File Hosting: Cloudinary

Getting Started

Follow these steps to set up Prime Eats on your local machine:

  1. Clone the Repository:

    git clone https://github.com/AbdeljalilOuafi/Prime-Eats.git
  2. Set up the backend:

    cd Prime-Eats/backend
    bash init.sh
    python utils/populate_db.py
    python manage.py runserver
  3. Set up the frontend:

    cd ../frontend
    npm install
    npm run dev
  4. Run the application:


Contribution Guidelines

We welcome contributions from everyone! Follow these steps to contribute:

  1. Fork the Repository: Click the 'Fork' button on GitHub.
  2. Create a Feature Branch:
    git checkout -b feature/your-feature-name
  3. Make Changes: Develop your feature or fix the bug.
  4. Commit Your Changes:
    git commit -m "feat: Add your feature description"
  5. Push Your Branch:
    git push origin feature/your-feature-name
  6. Create a Pull Request: Submit your pull request to the main repository and await feedback.

Connect With Us

Feel free to connect with our team for any queries, suggestions, or feedback:

About

Modern, community-driven web application where restaurant owners and food enthusiasts can connect.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5