https://github.com/nikitachalykh/deposit_calculator
REST API for deposit calculator
https://github.com/nikitachalykh/deposit_calculator
docker fastapi pytest python3 rest-api
Last synced: about 2 months ago
JSON representation
REST API for deposit calculator
- Host: GitHub
- URL: https://github.com/nikitachalykh/deposit_calculator
- Owner: NikitaChalykh
- Created: 2024-03-08T08:02:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T08:33:43.000Z (over 1 year ago)
- Last Synced: 2025-03-04T09:32:45.512Z (over 1 year ago)
- Topics: docker, fastapi, pytest, python3, rest-api
- Language: Python
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
REST API service for deposit calculator
=====
Project description
----------
The project is an API service for calculating deposits based on the received data vector.
The project is deployed in a Docker container.
The project is covered with unit tests.
System requirements
----------
* Python 3.11+
* Docker
* Works on Linux
Technology stack
----------
* Python 3.11+
* fastapi 0.103.2
* pytest
* Docker, Docker Compose
Installing the project from the repository
----------
1. Cloning the repository::
```bash
git clone https://github.com/NikitaChalykh/deposit_calculator.git
cd deposit_calculator # Go to the directory with the project
```
2. Create a ```.env``` file using ```env.example``` as a template
3. Installing and running the project in a container:
```bash
docker compose up -d
```
4. Launching unit tests:
```bash
docker exec -it deposit-calculation-service pytest
```
Project documentation
----------
Documentation for the API (swagger) after installation is available at:
```http://127.0.0.1:8000/docs/```