diff --git a/README.md b/README.md index d1b303c..ebba4c4 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ +# lean4game fork + +Questo è un fork di **lean4game** con supporto per essere self-hostato con Docker. + +## Deployment con Docker Compose + +Dopo aver clonato questa repo, per prima cosa serve creare [un token di API per GitHub](https://github.com/settings/developers) per permettere a lean4game di importare da solo i vari "game". Possiamo mettere questo token ed il nostro nome utente in un file `.env` come segue + +``` +export LEAN4GAME_GITHUB_USER='...' +export LEAN4GAME_GITHUB_TOKEN='...' +``` + +poi per lanciare tutto con docker compose basta eseguire + +```bash +$ source .env +$ docker compose up -d +``` + +Questo comando lancierà lean4game su `http://locahost:8080`. + +### Aggiungere Giochi + +Per scaricare nuovi giochi basta fare una chiamata al seguente url + +- `https://{host}/import/trigger/{org}/{repo}` + +Ad esempio per scaricare basta andare all'indirizzo `https://{host}/import/trigger/leanprover-community/nng4` per aggiungere _Natural Number Game_. + +--- + # Lean 4 Game This is the source code for a Lean game platform hosted at [adam.math.hhu.de](https://adam.math.hhu.de).