Skip to content

Commit

Permalink
chore(README): better instructions (#58)
Browse files Browse the repository at this point in the history
Signed-off-by: Aleksa Siriški <[email protected]>
  • Loading branch information
aleksasiriski authored Dec 17, 2024
1 parent 6dfe04d commit a52b2d1
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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`.

0 comments on commit a52b2d1

Please sign in to comment.