Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shvixxl/tablic
Online virtual tabletop 🎲
https://github.com/shvixxl/tablic
docker fastapi python typescript vuejs
Last synced: about 2 months ago
JSON representation
Online virtual tabletop 🎲
- Host: GitHub
- URL: https://github.com/shvixxl/tablic
- Owner: shvixxl
- License: mit
- Created: 2021-02-02T13:09:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-27T07:43:23.000Z (4 months ago)
- Last Synced: 2024-08-27T08:54:47.253Z (4 months ago)
- Topics: docker, fastapi, python, typescript, vuejs
- Language: Python
- Homepage:
- Size: 2.58 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Tablic
Web Application.
- [Tablic](#tablic)
- [Requirements](#requirements)
- [Backend](#backend)
- [Frontend](#frontend)
- [Using this Project](#using-this-project)
- [Configuration](#configuration)
- [Additional Configuration](#additional-configuration)
- [Logging](#logging)
- [Development](#development)
- [Endpoints](#endpoints)
- [License](#license)
## Requirements
### Backend
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
### Frontend
## Using this Project
### Configuration
Create a copy of `.env.example` file and rename it to `.env`:
```bash
cp .env.example .env
```
Open `.env` file and set these environment variables:
- `DB_PASSWORD` - mongodb password.
- `SECRET_KEY` - backend server secret key.
#### Additional Configuration
##### Logging
For reference use the [Loguru documentation](https://loguru.readthedocs.io/en/stable/api.html#).
- [`LOGGING_LEVEL`](https://docs.python.org/3/library/logging.html#logging-levels) - The minimum severity level from which logged messages should be sent to the sink. *Default* is `20` or `INFO`.
- `LOGGING_FORMAT` - The template used to format logged messages.
- [`LOGGING_ROTATION`](https://loguru.readthedocs.io/en/stable/api/logger.html#file) - A condition indicating whenever the current logged file should be closed and a new one started. *Default* is `1 day`.
- [`LOGGING_RETENTION`](https://loguru.readthedocs.io/en/stable/api/logger.html#file) - A directive filtering old files that should be removed during rotation or end of program. *Default* is `1 month`.
- [`LOGGING_COMPRESSION`](https://loguru.readthedocs.io/en/stable/api/logger.html#file) - A compression or archive format to which log files should be converted at closure. *Default* is `tar.gz`.
### Development
Start the stack with `docker-compose`:
```bash
docker-compose up -d
```
To check the logs, run:
```bash
docker-compose logs
```
To check the logs of a specific service, add the name of the service, e.g.:
```bash
docker-compose logs backend
```
To bring the stack down, run:
```bash
docker-compose down
```
#### Endpoints
- *Client*:
- *API*:
- *Interactive documentation* (Swagger UI):
- *Alternative documentation* (ReDoc):
## License
[MIT](LICENSE)