Skip to content

Latest commit

 

History

History
61 lines (31 loc) · 2.86 KB

README.md

File metadata and controls

61 lines (31 loc) · 2.86 KB
Raw

Crab Eats: Online Food Ordering System (Frontend)

Welcome to the frontend repository of Crab Eats! This project is a comprehensive online food ordering system. The backend code can be found here.

Tech Stack

The frontend is developed using ReactJS and Ant Design, while the backend is built with Java, Spring, and Hibernate.

Frontend

The frontend of Crab Eats is designed to be interactive and user-friendly:

  • Interactive UI: Built using ReactJS, the UI is dynamic and responsive.

  • Shopping Cart: Users can add menu items to their cart and place orders with ease.

  • User-Friendly Design: The application uses Ant Design to provide a clean, minimalist, and easy-to-navigate interface.

Backend

The backend of Crab Eats boasts several features:

  • REST API: Implemented via Spring MVC, the API provides endpoints for user registration, menu searching, food ordering, and checkout functionalities.

  • Data Storage and Access: Hibernate is used for data storage and operations, enabling complex operations such as retrieving the menu and various restaurant details.

  • Security: Spring Security is used for user authentication and authorization, ensuring that only authenticated users have access to their respective accounts.

  • Loose Coupling: The Spring Framework's core technologies are used to loosely couple all the components in the application, resulting in a modular design that enhances maintainability and scalability.

Getting Started

Frontend Setup (React.js)

  1. Clone the Repository: Clone this repository to your local machine using the command git clone https://github.com/crabsatellite/crabEats_frontend.git.

  2. Setup Environment Variables: Navigate to the directory where the project resides. Add the API endpoints and other necessary configurations to your .env file.

  3. Run the Frontend Server: Open a terminal in the project's root directory. Install the necessary dependencies by running npm install, then start the application using npm start.

Backend Setup (Java)

  1. Clone the Repository: Clone the backend repository to your local machine using the command git clone https://github.com/crabsatellite/crabEats_backend.git.

  2. Setup Environment Variables: Navigate to the directory where the project resides. Add your database credentials and other necessary configurations to your .env file or application.properties file.

  3. Run the Backend Server: Open a terminal in the project's root directory and start the application using ./mvnw spring-boot:run.

Contributions

This project is still under development. Contributions are very welcome!

License

This project is licensed under the MIT License. See LICENSE for more information.

Contact

Feel free to get in touch if you have any questions.

Enjoy ordering your meals with Crab Eats!