Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/virgil993/javawebproject

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/virgil993/javawebproject
Owner: Virgil993
Created: 2023-11-29T16:19:24.000Z (12 months ago)
Default Branch: main
Last Pushed: 2024-01-16T22:47:44.000Z (10 months ago)
Last Synced: 2024-01-18T01:52:18.858Z (10 months ago)
Language: Java
Size: 112 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# JavaWebProject

## Food Delivery Application

My project will consist of a food delivery application. This application will allow users to order food from different restaurant/companies.
The user will be able to fill up his shopping cart with items from a certain restaurant and then order the food. The food will
be delivered by a delivery driver who is part of our application's system.
Each restaurant can add menus .
Each restaurant can have multiple menus based on different themes they want to use
(eg. Fitness Menu, Heavy Menu, Vegan Menu, All In One Menu).
Each restaurant can have only one address.
Each menu will have multiple items on it.
A user can choose a restaurant, then he can choose one of the available menus and then choose items and create an Order.
Each user can have multiple addresses where he may want its food to be delivered.
Each User/Restaurant/Driver will have an Order History.
Each driver can work for one or multiple restaurants. When a driver is hired, by default,
he can deliver from any restaurant, if it so happens that one restaurant and one driver to not get along well, then that restaurant
will be subtracted from the list of restaurants that driver can deliver from.

Tables:
- User
- Restaurant
- Driver
- Item
- Menu
- Order
- Address
- RestaurantDriverAssociation
- OrderItemAssociation

## API Endpoints

1. **Register User**

- Path: `/api/users/register`
- Type: `POST`
- Body: `{name: String, email: String, password:String, phoneNumber:String}`
- Response: `{ userId: UUID, name: String, email: String, phoneNumber:String }`

2. **Login User**

- Path: `/api/users/login`
- Type: `POST`
- Body: `{ email: String, password:String}`
- Response: `{ token: String, userId: UUID, name: String, email: String}`

3. **Register Driver**

- Path: `/api/drivers/register`
- Type: `POST`
- Body: `{name: String, email: String, password:String, phoneNumber:String, vehicle: String, age: Int, deliveryExperience: String }`
- Response: `{ driverId: UUID, name: String, email: String, phoneNumber:String, vehicle: String, age: Int, deliveryExperience: String }`

4. **Login Driver**

- Path: `/api/drivers/login`
- Type: `POST`
- Body: `{ email: String, password:String}`
- Response: `{ token: String, userId: UUID, name: String, email: String}`

5. **Register Restaurant**

- Path: `/api/restaurants/register`
- Type: `POST`
- Body: `{name: String, email: String, password:String, priceRating: Int, Rating: Int, FoodType:List, supportPhoneNumbers: List}`
- Response: `{ restaurantId: UUID, name: String, email: String }`

6. **Login Restaurant**

- Path: `/api/restaurants/login`
- Type: `POST`
- Body: `{ email: String, password: String}`
- Response: `{ token: String, restaurantId: UUID, name: String, email: String }`

7. **Get Restaurants**

- Path: `/api/restaurants`
- Type: `GET`
- Response: `[{ restaurantId: UUID, name: String, priceRating: Int, Rating: Int, FoodType:List, supportPhoneNumbers: List },...]`

8. **Create Menu**

- Path: `/api/menus/`
- Type: `POST`
- Body: `{ restaurantId: UUID, name: String, availability: Boolean}`
- Response: `{ menuId: UUID, restaurantId: UUID, name: String, availability: Boolean}`

9. **Get Menus By restaurantId**

- Path: `/api/menus/{restaurantId}`
- Type: `GET`
- Params: `restaurantId: UUID`
- Response: `[{ menuId: UUID, restaurantId: UUID, name: String, availability: Boolean },...]`

10. **Update Menu Availability**

- Path: `/api/menus/{menuId}/availability`
- Type: `PUT`
- Params: `menuId (UUID)`
- Body: `{ availability: Boolean}`
- Response: `{ menuId: UUID, restaurantId: UUID, name: String, availability: Boolean}`

11. **Delete Menu**

- Path: `/api/menus/{menuId}`
- Type: `DELETE`
- Params: `menuId (UUID)`
- Response: `{ message: String }`

12. **Create Item**

- Path: `/api/item/`
- Type: `POST`
- Body: `{ menuId: String, name: String, price: Float}`
- Response: `{ itemId, menuId: String, name: String, price: Float}`

13. **Get Items By menuId**

- Path: `/api/item/{menuId}`
- Type: `GET`
- Params: `menuId: UUID`
- Response: `[{ itemId, menuId: String, name: String, price: Float},...]`

14. **Delete Item**

- Path: `/api/item/{itemId}`
- Type: `DELETE`
- Params: `itemId (UUID)`
- Response: `{ message: String }`

15. **Create Order**

- Path: `/api/order/`
- Type: `POST`
- Body: `{ userId: UUID, restaurantId:UUID, driverId:UUID, addressId: UUID, status: string}`
- Response: `{ orderId: UUID, userId: UUID, restaurantId:UUID, driverId:UUID, addressId: UUID}`

16. **Get Orders By userId**

- Path: `/api/order/user/{userId}`
- Type: `GET`
- Params: `userId: UUID`
- Response: `[{ orderId: UUID, userId: UUID, restaurantId:UUID, driverId:UUID, addressId: UUID},...]`

17. **Get Orders By restaurantId**

- Path: `/api/order/restaurant/{restaurantId}`
- Type: `GET`
- Params: `restaurantId: UUID`
- Response: `[{ orderId: UUID, userId: UUID, restaurantId:UUID, driverId:UUID, addressId: UUID},...]`

18. **Get Orders By driverId**

- Path: `/api/order/driver/{driverId}`
- Type: `GET`
- Params: `driverId: UUID`
- Response: `[{ orderId: UUID, userId: UUID, restaurantId:UUID, driverId:UUID, addressId: UUID },...]`

19. **Delete Order**

- Path: `/api/order/{orderId}`
- Type: `DELETE`
- Params: `orderId (UUID)`
- Response: `{ message: String }`

21. **Update Order**

- Path: `api/order/item/association`
- Type: `DELETE`
- Body: `{ userId: UUID, restaurantId:UUID, driverId:UUID, addressId: UUID}`
- Response: `{ orderId: UUID, userId: UUID, restaurantId:UUID, driverId:UUID, addressId: UUID}`

22. **Add driver to restaurant**

- Path: `api/restaurant/driver/association`
- Type: `POST`
- Body: `{ restaurantId: UUID, driverId: UUID}`
- Response: `{ message: String}`

23. **Remove driver from restaurant**

- Path: `api/restaurant/driver/association`
- Type: `DELETE`
- Body: `{ restaurantId: UUID, driverId: UUID}`
- Response: `{ message: String }`

24. **Add address for user**

- Path: `api/address/`
- Type: `POST`
- Body: `{ userId: UUID, city: String,street: String, house: String, details: String}`
- Response: `{ addressId: UUID, userId: UUID, city: String,street: String, house: String, details: String}`

25. **Get all addresses by userId**

- Path: `/api/address/all/{userId}`
- Type: `GET`
- Params: `userId: UUID`
- Response: `[{ addressId: UUID, userId: UUID, city: String,street: String, house: String, details: String},...]`

26. **Get single address**

- Path: `/api/address/single/{addressId}`
- Type: `GET`
- Params: `addressId: UUID`
- Response: `{ addressId: UUID, userId: UUID, city: String,street: String, house: String, details: String}`

27. **Delete address**

- Path: `api/address/{addressId}`
- Type: `DELETE`
- Params: `addressId: UUID`
- Response: `{ message: String }`