README.md

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing

About The Project

This app allows to simulate restaurant with dishes and orders

Built With

• Spring Web
• Spring Security
• Spring Data JPA
• PostgreSQL
• Springdoc
• JWT
• Logback
• Spring OAP
• RabbitMQ

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• You need docker and docker-compose to be installed on your machine.
• Also you need maven to build app. Alternately you can use jar from release.

Installation

1. Clone the repo

git clone https://github.com/TimNekk/OrderFlow

2. Build with Maven

mvn clean package -DskipTests

3. Rename .env.dist file to .env

mv .env.dist .env

4. Generate JWT secret key

• Got to https://allkeysgenerator.com/
• Choose Encryption key and 256-bit
• Check yes for Hex

5. Fill .env with corresponding data

6. Run app

docker-compose up --build

Usage

• Swagger UI is available at http://localhost:8080/swagger-ui/index.html
• PGAdmin is available at http://localhost:5050
• RabbitMQ is available at http://localhost:15672

Endpoint are protected with JWT, so make sure to register first and authorize using Bearer token.

MANAGER role allows to access api/v1/dish and api/v1/dishes

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request