musicbox.fun — a web app for making music box songs.
For the background on this project, see: https://www.bryanbraun.com/2019/11/02/music-box-fun
This repo contains two services, each in their own directory:
site
- A static frontend, written in plain JavaScriptapi
- A backend API, using Rails::API and PostgresEach service has a README. There are also some project-wide docs here.
First Time Setup
make
installed.brew install caddy nss
npm ci --prefix site
, to download cypress.Local development
To run the services locally, you just need to run the make commands:
make dev
- Runs development environments for the main app (site
and api
)make stop
- Stops any running environments for the main app (site
and api
)make test
- Run testsFor more commands, see the Makefile.
Contributing code
make test
)master
branch of the main repo.This project uses the GNU GPLv3 License, amended with the Commons Clause.
This means you get the terms of the GPLv3, excluding the permission to use it for commercial use.