Skip to content

Latest commit

 

History

History
82 lines (53 loc) · 3.35 KB

README.md

File metadata and controls

82 lines (53 loc) · 3.35 KB
Raw

Food Delivery Application

License

Welcome to the Food Delivery Application, an open-source project built with React, Redux, Firebase, Tailwind, and Cloud Functions. This application provides a comprehensive solution for food delivery, featuring an admin portal and a client application. It supports various authentication mechanisms, including Google Auth, and ensures real-time data updating.

Screenshots

Desktop Mobile
screencapture-localhost-3000-2023-07-09-08_11_05 mobile

Features

  • Admin portal with a user-friendly interface for managing the food delivery system.
  • Client application for users to place food orders easily.
  • Seamless integration with Firebase for data storage and real-time synchronization.
  • Authentication mechanisms:
    • Google Auth for secure login and user management.
    • Additional authentication methods for flexibility and convenience.
  • Real-time data updating, ensuring users have the latest information on their orders.
  • Open-source project, inviting contributors to join and help in future development.

Technologies Used

  • Frontend:
    • React: A JavaScript library for building user interfaces.
    • Redux: A predictable state container for managing application state.
    • Tailwind: A utility-first CSS framework for rapid UI development.
  • Backend:
    • Firebase: A comprehensive development platform for building web and mobile applications.
    • Cloud Functions: Serverless functions for extending Firebase functionality and handling backend operations.

Installation

To set up the Food Delivery Application on your local machine, follow these steps:

  1. Clone the repository: git clone https://github.com/your-username/food-delivery-app.git
  2. Navigate to the project directory: cd food-delivery-app
  3. Install the dependencies: npm install
  4. Configure Firebase:
    • Create a new Firebase project at https://console.firebase.google.com.
    • Obtain your Firebase configuration details.
    • Update the configuration in the .env file located in the project's root directory.
  5. Start the application: npm start
  6. Access the application in your browser at http://localhost:3000.

Contributing

We welcome and appreciate contributions from the community. To contribute to the Food Delivery Application, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature: git checkout -b feature-name
  3. Make your changes and commit them: git commit -m 'Add some feature'
  4. Push the changes to your fork: git push origin feature-name
  5. Open a pull request in the original repository, describing your changes.

License

This project is licensed under the MIT License.

We hope you find the Food Delivery Application useful and look forward to your contributions. If you have any questions or need assistance, please reach out to us. Happy coding!

Made with ❤️ by Gimnath Perera