Working on metars, updating ui drawer
This commit is contained in:
16
README.md
16
README.md
@@ -6,9 +6,12 @@
|
||||
## Makefile
|
||||
* `make` or `make help` to list all commands
|
||||
* `make docker-up` to start all containers
|
||||
* `make docker-refresh` to start the background services
|
||||
* `make docker-clean` to stop and delete all containers, volumes, and networks related
|
||||
to the application
|
||||
|
||||
**WARNING**: Running `make docker-clean` or `make docker-refresh` will wipe the database, redis, and minio data
|
||||
|
||||
## Setup
|
||||
|
||||
1. Override any environment variables in `.env.local`
|
||||
@@ -20,7 +23,16 @@ to the application
|
||||
* Running just `make cert` will generate `localhost` certificates
|
||||
4. Run the application with `make up`
|
||||
|
||||
### Development Environment
|
||||
Start background services with `make docker-refresh`
|
||||
* Note: when `ENVIRONMENT` is not set to `production` (i.e., set to `development`),
|
||||
the nginx container will function only as a reverse proxy - the UI must be run through `make run-ui`
|
||||
|
||||
Start the UI through `make run-ui` and the API through `make run-api`
|
||||
|
||||
### Production Environment
|
||||
Start with `make docker-up`
|
||||
|
||||
The most likely to change environment variables are the following:
|
||||
* `UI_PORT`
|
||||
* `API_PORT`
|
||||
@@ -71,3 +83,7 @@ The following resources were used to help decode METARS.
|
||||
|
||||
### Other data
|
||||
- https://www.faa.gov/air_traffic/weather/asos
|
||||
|
||||
## Tests
|
||||
`cargo test metars::model::tests::test_parse_time -- --exact --nocapture
|
||||
`
|
||||
|
||||
Reference in New Issue
Block a user