Bowled Server

Backend server for Bowled.gg

Folder Structure

• .vscode
  • launch.json: VSCode debug configuration
  • settings.json: VSCode Formatting settings
• /app
  • main.py: FastAPI application entrypoint
  • import_routes.py: HTTP Endpoint routers
  • middleware.py: Middleware hooks (ex: Logging)
• /bowled_match_engine
  • This directory is a submodule of the match engine repo (currently private)
• /db_scrips
  • create_tables.sql: SQL script to create tables
  • insert_sample_data.sql: SQL script to insert sample data
• /deployment
  • nginx: Nginx configuration and dockerfile
  • rest_server: REST server dockerfile
  • volumes: Directory for persistent data
• /dev: Dev scripts dustbin
• /gamelib
  • cache_manager: Cache manager
  • player: Player related functions
  • team: Team related functions
  • data_models: Data models for the game
• /lib
  • core: Core libraries for rest server
    • auth_bearer: Authentication handler
    • cache_store: Redis connector
    • data_store: Postgres connector
    • logger: Logging handler
  • utils: Utility functions
• /logs: Directory to store persistent logs
• /rest_server: HTTP endpoint handlers
• .pre-commit-config.yaml: Pre-commit configuration
• docker-compose.yml: Docker compose configuration
• docker-local.yml: Docker compose configuration for local development
• doppler.yaml: Doppler configuration for secrets
• pyproject.toml: Python project configuration

Local Development

• Install Poetry
• Install VSCode
• Clone the repo git clone https://github.com/bunsamosa/bowled_server.git
• Change directory cd bowled_server
• Install project dependencies with poetry poetry install
• Install pre-commit hooks pre-commit install
• The project uses Doppler for secrets management. However, you can use the environment variables listed below.
• Setup the following environment variables
  • REDIS_HOST: Redis connection URI
  • JWT_ALGORITHM: HS256
  • JWT_SECRET: Secret key for JWT
  • JWT_AUDIENCE: Depends on your JWT authentication provider
  • POSTGRES_URL: Postgres connection URI
  • POSTGRES_SCHEMA: Postgres schema name
• Hit F5 to start the server (VS Code will automatically start the debugger)
• Visit http://127.0.0.1:9009/docs to view the API docs
• Setup tables and sample data using scripts in /db_scripts