This project contains the web client (https://loved.sh), web server (https://loved.sh/api), and related tools for osu!'s Project Loved. See cl8n/project-loved for more management tools.
The provided docker-compose configuration sets up a development environment with the client, API, MySQL, and Nginx. The client is served from http://localhost:8080 by default. Server environment variables under "API server options" and "MySQL connection options" are overridden in this environment.
/server/migrations contains SQL to create the project_loved database schema. There are no backward migrations.
On the first run of the database container, the project_loved user will be created with an empty password. MySQL is exposed to the host machine on port 3306. The project_loved database will be created and existing migrations will be applied, but future ones need to be run manually.
Regular data exports (sans logs, log_values, and sessions) are posted to https://loved.sh/exports. This will drop and re-create all other tables!
docker-compose exec database /import-live-data.sh [export URL]
docker-compose run --rm api ./build/init-user.js <osu! username>
cd client
npm install
npm run build
The built webpage will be in /client/build; it's an SPA.
-
cd server npm install npm run build - Copy
.env.exampleto.envand fill in the options, or export the environment variables separately - Run server
- Directly:
NODE_ENV=production ./build/index.js - With systemd: See provided
project-loved-web.example.service
- Directly:
Request paths under /api should proxy to the server, paths exactly matching files should serve the files, and everything else should serve the client's index.html.