Skip to content

cdriehuys/flight-school

Repository files navigation

Flight School

A web app for tracking confidence in knowledge of the Airman Certification Standards (ACS). At a high level, each ACS is broken down into areas which contain tasks which contain elements. This app helps track which parts of the ACS you have the least confidence in so you can study efficiently.

Prerequisites

The application expects to have a Postgres database available.

Build It

Build tasks are orchestrated with just. The main entrypoint for building the application is:

just build

Other tasks can be viewed via just --list.

Run It

The main web application can be built from ./cmd/flight-school. It launches a web server that listens to 0.0.0.0:8000.

Run the flight-school web server

Usage:
  flight-school [flags]
  flight-school [command]

Available Commands:
  completion   Generate the autocompletion script for the specified shell
  help         Help about any command
  migrate      Migrate the database forwards
  populate-acs Populate the database with a particular ACS

Flags:
      --debug                 Enable debug logging
      --dsn string            DSN for connecting to the database ($FLIGHT_SCHOOL_DSN)
  -h, --help                  help for flight-school
      --static-dir string     Use static files from this path instead of the embedded files
      --template-dir string   Use templates from this path instead of the embedded files

Use "flight-school [command] --help" for more information about a command.

There's an additional sub-command, populate-acs, that is useful for populating the database with the contents of a particular ACS. It accepts the path to a JSON file as a single positional argument.

Populate the database with a particular ACS

Usage:
  flight-school populate-acs definition-file [flags]

Flags:
  -h, --help   help for populate-acs

Global Flags:
      --debug        Enable debug logging
      --dsn string   DSN for connecting to the database ($FLIGHT_SCHOOL_DSN)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages