diff --git a/README.md b/README.md index e7c7c41..8ebea9c 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ Simple webapp to mark students and employees entry and exit times. Made by students, for students. Built in SvelteKit + Postgres (with fuzzystrmatch extention). +## Prerequisites + +The following programs are needed to develop this project: + +- `node` +- `pnpm` +- `docker` / `podman` +- `docker compose` / `podman-compose` +- `make` (optional) + +Setup enviroment variables (adjust as needed): + +```bash +cp .env.example .env +``` + ## Development Install dependencies: @@ -10,6 +26,12 @@ Install dependencies: pnpm i --frozen-lockfile ``` +or: + +```bash +make install +``` + You also need docker (with compose plugin) or podman (with podman-compose) to start up the Postgres database: ```bash @@ -43,3 +65,7 @@ or: ```bash podman-compose -f docker-compose.prod.yaml up -d ``` + +## First steps + +After deploying the project, either for development or production, visit `/admin` path and in the sidebar create at least 1 building, at least 1 department and at least 1 user. Afterwards, by going to the homepage you will be able to log in using the created user credentials. For all of the admin actions you must pass the secret set via the environment variable `SECRET`.