Skip to content

Commit

Permalink
update root readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dheidemann committed Jul 18, 2024
1 parent 3b5e145 commit b1de1e3
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,25 @@
# pepp
## dev ([todos](https://github.com/FachschaftMathPhysInfo/pepp/issues/1))
> **P**raktische **E**rsti-**P**rogramm**p**lanung
## build
1. `cp .env .env.local`
2. `docker compose build`
3. `docker compose up -d && docker compose logs -f`

The API is now reachable on `localhost:8080/api`.
Documentation for all endpoints can be found in the `README.md` inside `server/`. Messing around with the API is possible via the GraphQL Playground on `localhost:8080`.
- Frontend: [localhost:8080](http://localhost:8080)
- API: [localhost:8080/api](http://localhost:8080/api)
- GraphQL Playground: [localhost:8080/playground](http://localhost:8080/playground)
- Documentation for all endpoints can be found in the [`server/README.md`](server/README.md)

### dev
#### frontend
1. `cd frontend`
2. `npm i`
3. `npm run dev`

#### backend

i just rebuild the docker image on change

For the E-Mail verification to work you have to provide a smtp server inside your `.env.local`, e.g.:
```
Expand All @@ -15,6 +29,7 @@ SMTP_PASSWORD=1234
SMTP_PORT=465
FROM_ADDRESS=vorkurs@example.de
```

## contributions
1. [create an issue](https://github.com/FachschaftMathPhysInfo/pepp/issues/new)
2. from this issue create a branch and work on it
Expand Down

0 comments on commit b1de1e3

Please sign in to comment.