https://github.com/kamlendras/ueats-web

A glossly online food service and food delivery platform for the web, Made to keep track of your health.
https://github.com/kamlendras/ueats-web

mui nextjs reactjs

Last synced: 2 months ago
JSON representation

A glossly online food service and food delivery platform for the web, Made to keep track of your health.

• Host: GitHub
• URL: https://github.com/kamlendras/ueats-web
• Owner: kamlendras
• License: gpl-3.0
• Created: 2023-05-18T20:57:19.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-09T20:28:06.000Z (6 months ago)
• Last Synced: 2024-11-02T00:42:24.363Z (3 months ago)
• Topics: mui, nextjs, reactjs
• Language: JavaScript
• Homepage: https://ueats.vercel.app
• Size: 1.05 MB
• Stars: 5
• Watchers: 0
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
## Welcome to ueats!

 ueats is a user-friendly and customizable open-source platform that empowers you to build your own online food ordering system. It caters to both customers and restaurants, providing a seamless experience for ordering, managing, and delivering delicious meals.

## Key Features:

* User-Friendly Interface: Customers can browse menus, place orders conveniently, and track their delivery status effortlessly.

*  Restaurant Management: Restaurants can manage their menus, receive orders, and track deliveries efficiently.

*  Open Source: Freely contribute to the platform's development and customize it to your specific needs.

* Cryptocurrency Payments: ueats embraces the future of finance by accepting Bitcoin (BTC), Ethereum (ETH), and Monero (XMR) for secure and borderless transactions.

## Getting Started

## 1. Prerequisites:

- Node.js and npm (or yarn) installed on your system.

- Basic understanding of web development concepts.

## 2. Installation:

$ git clone https://github.com/universal-org/ueats.git


$ cd ueats


$ npm install (or yarn install)

## 3. Configuration:

- Create a .env file in the project root directory.

- Add your database connection details and any other necessary configuration variables.

- Refer to the config.example.env file for guidance.

## 4. Development Server:

$ npm start (or yarn start)

This will start the development server, typically accessible at  http://localhost:3000 (port may vary).

## 5. Deployment:

ueats is designed to be deployed on a web server of your choice (e.g., Vercel, Heroku, AWS). Deployment instructions will vary depending on the platform.

## Contribution

We welcome contributions from the community!

* Fork the repository on GitHub.

* Create a new branch for your feature or bug fix.

* Implement your changes and write clear unit tests.

* Submit a pull request for review.

## Community

Join the ueats community forum (link to be added) to discuss the platform, share ideas, and get help from other users.

## License

ueats is licensed under the GPL-3.0 License (see LICENSE file).