Harmonic

Harmonic is an open-source social media app that puts social agency before engagement metrics.

Development

Docker and Docker Compose are the only dependencies you need to have installed to run the app. For initial setup, first create a .env file for your environment variables, and a Caddyfile.

cp .env.example .env
cp Caddyfile.example ./Caddyfile

For development, you probably won't need to change any variables from .env.example, unless you are using a remote dev environment like GitHub Codespaces, in which case you will need to set HOSTNAME to the correct domain. For production, you will need to change other variables also.

Then use setup.sh to build the docker containers and initialize the database. You only need to run this once.

./scripts/setup.sh

To start the containers, run

./scripts/start.sh

To stop, run

./scripts/stop.sh