https://github.com/cdriehuys/flight-school
https://github.com/cdriehuys/flight-school
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cdriehuys/flight-school
- Owner: cdriehuys
- Created: 2023-07-09T15:56:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-04T15:40:42.000Z (5 months ago)
- Last Synced: 2025-01-04T16:28:26.728Z (5 months ago)
- Language: Go
- Size: 143 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Flight School
A web app for tracking confidence in knowledge of the
[Airman Certification Standards (ACS)][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`][just]. The main entrypoint for
building the application is:
```shell
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`.
```text
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.
```text
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)
```
[acs]: https://www.faa.gov/training_testing/testing/acs
[just]: https://github.com/casey/just