https://github.com/shamaevnn/covirally-tmp
https://github.com/shamaevnn/covirally-tmp
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/shamaevnn/covirally-tmp
- Owner: shamaevnn
- Created: 2022-12-20T14:07:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-21T11:03:16.000Z (over 2 years ago)
- Last Synced: 2025-01-22T20:34:57.126Z (5 months ago)
- Language: Python
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Coverally-tmp
## Task description
Service to store and transfer inner coins via FastAPI. Number of functions:
* 100 bonus coins for new users
* Transfer coins to other user regarding balance limits
* Viewing own balance
## API
These endpoints are available:
## First run
1. Create virtual environment and install dependencies
```bash
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements.dev.txt
```
2. Install `pre-commit` hooks
```
pre-commit install-hooks
pre-commit install
```
3. Create `.env` file, don't forget to set proper variables
```
cp .env_example .env
```
## Running locally
1. Run all necessary services
```bash
make services
```
2. Apply migrations
```
make migrate
```
3. Run backend on FastAPI
```
make dev
```
4. Check http://0.0.0.0:80/docs, everything should be OK!
## Tests
```
make run_tests
```
## Linter
```
make format
make lint
```