Skip to content

Latest commit

 

History

History
79 lines (57 loc) · 2.45 KB

README.md

File metadata and controls

79 lines (57 loc) · 2.45 KB

Foody

Foody is a comprehensive restaurant management application designed to streamline operations for restaurants. Built on Next.js and Prisma, and styled with Tailwind CSS, it extends a basic authentication system to include features essential for managing menus, orders, and customer interactions efficiently.

Hosted Version

Experience Foody live: Hosted Application Link

Based on Boilerplate

This project is built upon the Next.js Authentication Boilerplate. For more details on the boilerplate, visit: Next.js Authentication Boilerplate

Features

  • User Authentication: Secure login, signup, and logout functionalities.
  • Menu Management: An intuitive interface for managing restaurant menus.
  • Order Management: Track and manage orders in real-time.
  • Customer Management: Maintain detailed customer profiles and order history.
  • Tailwind CSS: Utilize Tailwind CSS for custom, responsive designs.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

  • Node.js
  • npm or Yarn

Installation

  1. Clone the repo 
    git clone https://github.com/your/Foody.git
  2. Navigate to the project directory 
    cd Foody
  3. Install NPM packages 
    npm install
    or with Yarn: 
    yarn install
  4. Set up your environment variables Create a .env file in the root directory and add the necessary environment variables as per the .env.example file.

Running the Application

  1. Run the development server 
    npm run dev
    or with Yarn: 
    yarn dev
  2. Open http://localhost:3000 with your browser to see the application.

Deployment

To deploy the application, you can use platforms like Vercel, Netlify, or any other hosting provider that supports Next.js applications.

Contributing

Contributions are what make the open-source community such an amazing place to be, learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  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

Distributed under the MIT License. See LICENSE for more information.