mirror of
https://github.com/davegallant/rfd-fyi.git
synced 2025-08-07 09:02:27 +00:00
46 lines
936 B
Markdown
46 lines
936 B
Markdown
# rfd-fyi
|
|
|
|
This repository provides a simple, less-distracting overlay for hot deals posted on https://forums.redflagdeals.com.
|
|
|
|
The frontend is made with Vue 3 and the backend is written in Go. The backend exists for caching purposes; to prevent excessive requests to RedFlagDeals itself.
|
|
|
|
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
|
|
make backend
|
|
```
|
|
|
|
In another pane/tab, run:
|
|
|
|
```sh
|
|
make frontend
|
|
```
|
|
|
|
## Docker Compose
|
|
|
|
To build containers from source:
|
|
|
|
```sh
|
|
make dev
|
|
```
|
|
|
|
To run the latest published images:
|
|
|
|
```sh
|
|
make prod
|
|
```
|