dave/rfd-fyi
1
0
Fork 0
mirror of https://github.com/davegallant/rfd-fyi.git synced 2025-08-06 07:13:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Dave Gallant
2022-11-05 22:53:04 -04:00
parent 96ded0e65c
commit 2ea2a0f130
1 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -6,8 +6,18 @@ The frontend is made with Vue 3 and the backend is written in Go. The backend ex
It is hosted at [rfd.fyi](https://rfd.fyi).
## Environment Variables
Ensure that an `.env` file is filled in with the appropriate values.
Example key/values can be found in [example.env](./example.env).
*Note: that a [honeycomb](https://honeycomb.io/) API key is currently required.*
## Local Development
If running locally, ensure that the ENV vars are exported to your shell.
To get up and running locally: in one pane/tab, run:
```sh
@@ -20,12 +30,6 @@ In another pane/tab, run:
make frontend
```
## Honeycomb
Ensure that an .env is filled in with appropriate values.
See [example.env](./example.env).
## Docker Compose
```sh