https://github.com/moseseth/lease-it
Spring boot app for leasing a vehicle to a customer
https://github.com/moseseth/lease-it
Last synced: 5 days ago
JSON representation
Spring boot app for leasing a vehicle to a customer
- Host: GitHub
- URL: https://github.com/moseseth/lease-it
- Owner: moseseth
- Created: 2023-09-07T05:15:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-10T12:01:33.000Z (almost 3 years ago)
- Last Synced: 2025-02-25T01:44:11.844Z (over 1 year ago)
- Language: Java
- Homepage:
- Size: 643 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/moseseth/lease-it/actions/workflows/tests.yml)
Service for leasing a vehicle to a customer
----------------------------------------------
#### Entity Relationship Design
This project is a web application that allows you to manage vehicle leasing, customers, and lease contracts. It uses MySQL for persisting data, Spring boot with Java 17 as the backend service, and React as a frontend tool.
### How to Run
You can run the project using Docker.
- *Requires Docker Desktop*. Then, follow these steps:
1. Clone the repository and `cd lease-it`
2. Rename `.env.example` to `.env` under `lease-api/`
3. Go to the root directory and run: `docker compose up -d`
4. The backend service will be available at `localhost:9090/api`
5. The frontend UI will be available at `localhost` (port 80)
### Unit tests for lease-api
All code pushes to github has to pass unit tests using GitActions workflow.
Available under .github/tests and the badge is a legit one too :)
### API Documentation
You can access the API documentation at `localhost:9090/api/docs`
### Features
- The backend service supports all the required operations and provides paging for Contract overview
GET requests to improve performance.
- Bonus: A frontend UI uses Material-UI designs & allows view contract overviews only [task focused on Backend]
