/geoboard

Geoboard is a project where you can create a dashboard with various widgets containing weather information: temperature for seven next days, wind status, sunrise status, etc.

Primary LanguagePython

Geoboard

GitHub last commit

Geoboard is a project where you can create a dashboard with various widgets containing weather information: temperature for seven next days, wind status, sunrise status, etc.

This repository contains backend part of this project

Requirements

Installation

  1. Create the PostgreSQL Database and User
  2. Go to project directory and add .env file:
cp .env.template .env
  1. Configure .env: add database info, generate jwt key and etc.
  2. Install dependencies py poetry:
poetry install
  1. Start a shell session with the new environment with:
poetry shell
  1. Run database migrations:
alembic upgrade head
  1. Install pre-commit:
pre-commit install

Run project

cli run-server

You can get additional information about this command if you add --help flag

API documentation

Run project and open http://127.0.0.1:8000/api/v1/docs to see list of available endpoints

Commands

You can run special helper commands to create user, get users list, run server, etc:

# Create user:
cli user create

# Get more info about all available commands
cli --help