Tablic

Web Application.

• Tablic
  • Requirements
    • Backend
    • Frontend
  • Using this Project
    • Configuration
      • Additional Configuration
        • Logging
    • Development
      • Endpoints
  • License

Requirements

Backend

• Docker
• Docker Compose

Frontend

Using this Project

Configuration

Create a copy of .env.example file and rename it to .env:

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.

• LOGGING_LEVEL - 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 - A condition indicating whenever the current logged file should be closed and a new one started. Default is 1 day.
• LOGGING_RETENTION - A directive filtering old files that should be removed during rotation or end of program. Default is 1 month.
• LOGGING_COMPRESSION - 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:

docker-compose up -d

To check the logs, run:

docker-compose logs

To check the logs of a specific service, add the name of the service, e.g.:

docker-compose logs backend

To bring the stack down, run:

docker-compose down

Endpoints

• Client: http://localhost
• API: http://localhost:8000/api
• Interactive documentation (Swagger UI): http://localhost:8000/api/docs
• Alternative documentation (ReDoc): http://localhost:8000/api/redoc

License

MIT