Updated README
This commit is contained in:
14
README.md
14
README.md
@@ -1,4 +1,7 @@
|
|||||||
# Aviation
|
<div align="center">
|
||||||
|
<img src="docs/logo.png" alt="drawing" width="200"/>
|
||||||
|
<h1 align="center">Aviation Data</h1>
|
||||||
|
</div>
|
||||||
|
|
||||||
## Makefile
|
## Makefile
|
||||||
`make help` to list all commands
|
`make help` to list all commands
|
||||||
@@ -6,8 +9,13 @@
|
|||||||
## Setup
|
## Setup
|
||||||
|
|
||||||
1. Override any environment variables in `.env.local`
|
1. Override any environment variables in `.env.local`
|
||||||
2. Build the api and ui images with `make build`
|
2. Build the required images. Running just `make build` will build the `nginx` image
|
||||||
3. Run the application with `make up`
|
* `make build f=nginx`
|
||||||
|
* `make build f=api`
|
||||||
|
* `make build f=ui`
|
||||||
|
3. Generate the SSL certificates with `make cert d=<DOMAIN>`
|
||||||
|
* Running just `make cert` will generate `localhost` certificates
|
||||||
|
4. Run the application with `make up`
|
||||||
|
|
||||||
## Data Sources
|
## Data Sources
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user