diff --git a/README.md b/README.md index e69de29..9a167c8 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,29 @@ +# ELM (EZGG LAN Manager) + +ELM is the successor of [EZGG LAN Manager](https://git.ezgg-ev.de/Vereins-IT/ezgg-lan-manager) with an overhauled UI and a document-oriented database instead of SQL. + +# Development Setup + +## Local + +- Install Python requirements via `pip install -r requirements.txt`. +- Start A MongoDB (Version 8) +- Load clean dump via `mongorestore --uri="mongodb://localhost:27017" /path/to/clean_dump` +- Create user for DB + +```js +use admin + +db.createUser({ + user: "elm_user", + pwd: "elm_password", + roles: [ { role: "root", db: "admin" } ] +}) +``` +- Edit config accordingly + +## Docker + +- Change `docker-compose.yaml` entrypoint as needed (remove `--public` and `--release` usually) +- Build and run `docker-compose.yaml` +- Load clean dump via `mongorestore --uri="mongodb://user:password@localhost:27017" /path/to/clean_dump`