https://github.com/xanhex/comboss
Fighting combo app
https://github.com/xanhex/comboss
bootstrap5 css docker flask gunicorn jinja2 pytest python sqlalchemy sqlite
Last synced: 3 months ago
JSON representation
Fighting combo app
- Host: GitHub
- URL: https://github.com/xanhex/comboss
- Owner: xanhex
- License: apache-2.0
- Created: 2023-09-25T15:32:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-26T08:15:53.000Z (over 2 years ago)
- Last Synced: 2026-01-03T14:29:27.015Z (6 months ago)
- Topics: bootstrap5, css, docker, flask, gunicorn, jinja2, pytest, python, sqlalchemy, sqlite
- Language: Python
- Homepage:
- Size: 862 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Comboss
A microservice that provides the user with lists of fighting game character
combo.
## Technologies
- Python
- Flask
- Pytest
- SQLAlchemy
- Sqlite
- Jinja2
- Bootstrap 5
- CSS
- Gunicorn
- Docker
## Standards
- pep8
- flake8
- black
- pymarkdown
- mypy
## How to run
1. Clone the repository
2. Edit `csv` files from `src/data` folder if you need
3. Inside `src` folder run:
```bash
docker build -t comboss .
docker run --name comboss --rm -p 8000:8000 comboss
```
## Local development and testing
1. After cloning the project activate virtual environment and install
dependencies from `src/requirements.txt` file
2. To test the current functionality run `pytest` command
3. Add your models or edit existing in `models` file
4. Edit `config_default.py` to configure the app or put your private
`config.py` in `project_root/instance` folder
1. Edit `app.py` to add new functionality to the project.
2. To test the app work in Docker container switch comments in two last
lines in `src/Dokerfile`.
## Demo
