Skip to content

Commit

Permalink
updated documentation (#61)
Browse files Browse the repository at this point in the history
  • Loading branch information
dheidemann committed Jul 23, 2024
1 parent 3cd0ff2 commit 678cc39
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
3. `docker compose up -d && docker compose logs -f`

- Frontend: [localhost:8080](http://localhost:8080)
- ICal Calendar: [localhost:8080/ical?l="Tutorium"](http://localhost:8080/ical?l="Tutorium")
- ICal Calendar: [localhost:8080/ical?l=Tutorium](http://localhost:8080/ical?l="Tutorium")
- 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)
Expand All @@ -19,10 +19,9 @@
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.:
The backend sends emails (confirmation, ...). You need provide a smtp server inside your `.env.local`, e.g.:
```
SMTP_HOST=smtp.example.de
[email protected]
Expand Down
1 change: 1 addition & 0 deletions server/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,7 @@ func main() {
// [/]: Next.JS frontend
// [/api]: JSON API endpoint
// [/playground]: GraphQL Playground
// [/ical]: .ics calendar
// [/confirm/{sessionID}]: Confirm email addresses
router := chi.NewRouter()
router.Use(
Expand Down

0 comments on commit 678cc39

Please sign in to comment.