Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/p4zd4n/miesiany-miesiany-kebab

Full-stack application for fictional kebab restaurant called "Miesiany Miesiany Kebab" created with Spring and Angular
https://github.com/p4zd4n/miesiany-miesiany-kebab

angular docker hibernate html java junit lombok maven mockito postgresql scss spring-boot spring-data spring-security sql typescript

Last synced: 24 days ago
JSON representation

Full-stack application for fictional kebab restaurant called "Miesiany Miesiany Kebab" created with Spring and Angular

Host: GitHub
URL: https://github.com/p4zd4n/miesiany-miesiany-kebab
Owner: P4ZD4N
Created: 2024-07-30T21:24:36.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-11-20T22:36:03.000Z (about 2 months ago)
Last Synced: 2024-11-20T23:28:31.636Z (about 2 months ago)
Topics: angular, docker, hibernate, html, java, junit, lombok, maven, mockito, postgresql, scss, spring-boot, spring-data, spring-security, sql, typescript
Language: Java
Homepage:
Size: 3.46 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# 💻 Miesiany Miesiany Kebab

## 👀 About

Full-stack application for a fictional kebab restaurant called "Miesiany Miesiany Kebab". The application is also intended to serve as a restaurant's business card, in order to reach a larger number of customers, and to enable the fulfillment and tracking of orders.

## 🔧 Tech Stack

**Backend:** Java 21, Spring Boot 3, Spring Security, Spring Data, Hibernate, Lombok

**Frontend:** TypeScript 5, Angular 18, HTML, SCSS, Bootstrap

**Testing:** JUnit, Mockito

**Databases:** PostgreSQL, SQL

**Build tools:** Maven

**DevOps:** Docker, Bash

**Other tools used during development:** Postman, pgAdmin 4

## 💡 Features

- Session-based authentication system, taking into data security. For this purpose, I implemented storing passwords encrypted with the bcrypt algorithm in database.
- Eye-catching, well-tailored and well-thought user interface.
- Responsive Web Design to improve accessibility of page at all types of devices,
- Multilingual pages (Polish or English),
- Multilingual validation for all forms. Validation messages are sent by backend in appropriate language specified in request header,
- Integration with TomTom Map API to add map with pointer, which aims to help potential customers easily locate restaurant.
- Bash script, which starts PostgreSQL database, backend and frontend with one command.
- Possibility to display home page. This is the "first contact section", which means, that clients see it firstly, after navigating to /. For this reason, this section had to be best thought out from a marketing perspective. I placed there many informations, that can encourage potential customer to place the order. Home page is divided to four subsections: hero section, about us, awards and location. Subsections contain, among others, many marketing slogans, certificates, guarantees, acknowledgments and a map with a pointer.
- Possibility to display highlighted with proper color opening hours of restaurant on each day. Manager can easily update these hours.
- Possibility to display menu of the restaurant. In menu section clients can see three tables: meals, addons to your meal and beverages, which contains each item details like name, price, capacity or ingredients. This entire section is manageable by the manager. Employee with this role can add, update and remove each type of item. Items in each table are sorted by name.
- Possibility to display contact details. In contact section clients can see contact data (including phone number and email address), nicknames at social media and map with location pointer. Contact data is editable by manager.
- Job board, which enable to publish dateiled job offers by manager. Manager can add job offer with information such as position name, description, list of mandatory requirements, list of nice to have requirements, list of employment types and hourly wage gross. Once added, each job offer is fully customizable. Website guests can apply to each job offer by fulfilling form (with attaching a CV in PDF/DOC format!). Manager has possibility to display all candidates, which applied to job offer, remove those who do not fit the position or peek/download attached CV of desired candidate.

## 🔗 API

### AuthenticationController

#### POST /api/v1/auth/login

**Description:**
Authenticates a user if the credentials are valid. Returns proper validation messages in specified in `Accept-Language` header language and error details, if any.

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"email": "[email protected]",
"password": "password123"
}
```

#### POST /api/v1/auth/logout

**Description:**
Logs out currently logged in user, invalidating his session.

### HoursController

#### GET /api/v1/hours/opening-hours

**Description:**
Retrieves currently set up opening hours on all days of the week from the database.

#### PUT /api/v1/hours/update-opening-hour

**Description:**
Updates the opening hours for a specific day of the week.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"day_of_week": "TUESDAY",
"opening_time": "20:00",
"closing_time": "23:00"
}
```

### MenuController

#### GET /api/v1/menu/beverages

**Description:**
Retrieves all beverages, that are currently stored in the database.

#### POST /api/v1/menu/add-beverage

**Description:**
Add new beverage. It is possible to add new beverage with name of existing, but new beverage must have different capacity. For example, if db stores Coca-Cola with capacity 0.33L, you can add Coca-Cola with capacity 0.5L, but not with 0.33L.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"new_beverage_name": "Lipton",
"new_beverage_capacity": 0.5,
"new_beverage_price": 6
}
```

#### PUT /api/v1/menu/update-beverage

**Description:**
Updates existing beverage. If db already stores Coca-Cola with capacity 0.33L, you can't update Coca-Cola with capacity 0.5L to Coca-Cola with capacity 0.33L.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"updated_beverage_name": "Lipton",
"updated_beverage_price": 6,
"updated_beverage_new_capacity": 0.33,
"updated_beverage_old_capacity": 0.5
}
```

#### DELETE /api/v1/menu/remove-beverage

**Description:**
Removes existing beverage.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Body:**
```json
{
"name": "Lipton",
"capacity": 0.33
}
```

#### GET /api/v1/menu/addons

**Description:**
Retrieves all addons, that are currently stored in the database.

#### POST /api/v1/menu/add-addon

**Description:**
Add new addon. It is not possible to add addon with the same name of existing. For example, if db already stores Jalapeno, you can't add Jalapeno second time.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"new_addon_name": "Jalapeno",
"new_addon_price": 3
}
```

#### PUT /api/v1/menu/update-addon

**Description:**
Updates existing addon.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"updated_addon_name": "Jalapeno",
"updated_addon_price": 2.5
}
```

#### DELETE /api/v1/menu/remove-addon

**Description:**
Removes existing addon.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Body:**
```json
{
"name": "Jalapeno"
}
```

#### GET /api/v1/menu/meals

**Description:**
Retrieves all meals, that are currently stored in the database.

#### POST /api/v1/menu/add-meal

**Description:**
Add new meal. It is not possible to add meal with the same name of existing. For example, if db already stores 'Pita Kebab', you can't add 'Pita Kebab' second time. You can specify prices as you want. Even just with SMALL and MEDIUM sizes or with SMALL and XL, but it is necessary to specify at least one size. You should also specify at least one ingredient, which must be already added in database. Ingredients, which are displayed as "Base Ingredients" on the website are of type: BREAD, VEGETABLE and OTHER.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"new_meal_name": "Kebab",
"new_meal_prices": {
"SMALL": 20,
"MEDIUM": 22,
"LARGE": 25.5,
"XL": 30
},
"new_meal_ingredients": [
{
"name": "Tortilla",
"ingredient_type": "BREAD"
},
{
"name": "Tomato",
"ingredient_type": "VEGETABLE"
}
]
}
```

#### PUT /api/v1/menu/update-meal

**Description:**
Updates existing meal. You can specify prices and ingredients as you want, but it is necessary to add at least one for both.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"updated_meal_name": "Kebab",
"updated_meal_prices": {
"SMALL": 20,
"XL": 35
},
"updated_meal_ingredients": [
{
"name": "Pita",
"ingredient_type": "BREAD"
}
]
}
```

#### DELETE /api/v1/menu/remove-meal

**Description:**
Removes existing meal.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Body:**
```json
{
"name": "Kebab"
}
```

#### GET /api/v1/menu/ingredients

**Description:**
Retrieves all ingredients, that are currently stored in the database.

#### POST /api/v1/menu/add-ingredient

**Description:**
Add new ingredient. It is not possible to add ingredient with the same name as existing ingredient. It is possible to add ingredients of types: BREAD, MEAT, VEGETABLE, SAUCE and OTHER.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"new_ingredient_name": "Cucumber",
"new_ingredient_type": "VEGETABLE"
}
```

#### DELETE /api/v1/menu/remove-ingredient

**Description:**
Removes existing ingredient.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Body:**
```json
{
"name": "Cucumber"
}
```

### ContactController

#### GET /api/v1/contact/contacts

**Description:**
Retrieves all contacts, that are currently stored in the database.

#### PUT /api/v1/contact/update-contact

**Description:**
Updates existing contact. You can update contacts of type EMAIL or TELEPHONE.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"contact_type": "TELEPHONE",
"new_value": "123456789"
}
```

### JobsController

#### GET /api/v1/jobs/job-offers/manager

**Description:**
Retrieves all job offers, that are currently stored in the database. Response for manager contains all job offers properties including job offer applications.

**Authorization Requirements:**
- Role: `MANAGER`

#### GET /api/v1/jobs/job-offers/general

**Description:**
Retrieves all job offers, that are currently stored in the database. General response contain limited job offers properties (without job offer applications).

#### POST /api/v1/jobs/add-job-offer

**Description:**
Add new job offer. It is not possible to add job offer with the same position name as existing job offer. You can add job offer without specyfing job employment types and job requirements.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"position_name": "Cook",
"description": "Write something...",
"hourly_wage": 30,
"job_employment_types": [
{
"employment_type": "PERMANENT"
},
{
"employment_type": "MANDATE_CONTRACT"
}
],
"job_requirements": [
{
"requirement_type": "MANDATORY",
"description": ":)"
},
{
"requirement_type": "NICE_TO_HAVE",
"description": "nice to have"
}
]
}
```

#### PUT /api/v1/jobs/update-job-offer

**Description:**
Updates existing job offer. You can update each property of job offer, but if you enter new position name same as different, existing job offer, it will not work.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"position_name": "Cook",
"updated_position_name": "Coook",
"updated_description": "Write something...",
"updated_hourly_wage": 30,
"updated_employment_types": [
{
"employment_type": "PERMANENT"
},
{
"employment_type": "MANDATE_CONTRACT"
}
],
"updated_requirements": [
{
"requirement_type": "MANDATORY",
"description": ":)"
},
{
"requirement_type": "NICE_TO_HAVE",
"description": "nice to have"
}
],
"is_active": false
}
```

#### DELETE /api/v1/jobs/remove-job-offer

**Description:**
Removes existing job offer.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Body:**
```json
{
"position_name": "Cook"
}
```

#### POST /api/v1/jobs/add-job-offer-application

**Description:**
Add new job offer application. You can add job offer application without adding optional additional message.

**Request Headers:**
- `Accept-Language`: Specifies preferred language for the response. Default is `pl` (Polish). You can also set `en` (English).

**Request Body:**
```json
{
"position_name": "Cook",
"applicant_first_name": "Wiktor",
"applicant_last_name": "Chudy",
"applicant_email": "[email protected]",
"applicant_telephone": "123456789",
"additional_message": "Write something...",
"is_student": true
}
```

#### POST /api/v1/jobs/add-cv

**Description:**
Add CV to the job offer application.

**Request Params:**
- `applicationId`: The ID of application, to which the CV is being attached. Must be a numeric value.
* Type: `Long`
* Required: Yes
* Example: `12345`
- `cv`: The CV file in multipart/form-data format. Supported file formats: PDF, DOCX.
* Type: `MultipartFile`
* Required: Yes
* Example: File named `cv.pdf` uploaded as an attachment in the form.

#### GET /api/v1/jobs/download-cv/{id}

**Description:**
Download CV with specified ID.

#### DELETE /api/v1/jobs/remove-job-application

**Description:**
Removes existing job application from job offer.

**Authorization Requirements:**
- Role: `MANAGER`

**Request Body:**
```json
{
"position_name": "Cook",
"application_id": 1
}
```

## 📋 Requirements
- Java 21 (or higher)
- Docker
- ng
- npm

## 🌍 Environment Variables

To run this project and ensure, that app will work properly, you need to add the following line to your .env file. You need it to see the map with restaurant location on home page.

- `MAP_API_KEY=`

Do it step by step:
1. Navigate to `https://developer.tomtom.com/` and log in to your account. Then create new Map Display API key and copy it.
2. Create `.env` file on the following path: `/miesiany-miesiany-kebab/frontend/src/.env`
3. Add previously copied API key to `.env` file

## ▶️ Run

Clone the project

```bash
git clone [email protected]:P4ZD4N/miesiany-miesiany-kebab.git
```

Navigate to the frontend directory

```bash
cd /path/to/miesiany-miesiany-kebab/frontend
```

Install dependencies

```bash
npm install
```

Navigate to the project directory

```bash
cd /path/to/miesiany-miesiany-kebab
```

Run app

```bash
./start.sh
```

## ⚡ Usage

Navigate to the following URL in your web browser

```
http://localhost:4200
```

That's It! You can start using kebab app :)