rfd-fyi/README.md

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.

Environment Variables

Ensure that an .env file is filled in with the appropriate values.

Example key/values can be found in example.env.

Note: that a honeycomb 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:

make backend

In another pane/tab, run:

make frontend

Docker Compose

To build containers from source:

make dev

To run the latest published images:

make prod