From 678cc395d553ff41933c31370bb744ca3925357a Mon Sep 17 00:00:00 2001 From: Daniel Heidemann Date: Tue, 23 Jul 2024 23:05:33 +0200 Subject: [PATCH] updated documentation (#61) --- README.md | 5 ++--- server/server.go | 1 + 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad7012f..96cd90e 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 SMTP_USER=example@example.de diff --git a/server/server.go b/server/server.go index da3c8b8..6c4f1ae 100644 --- a/server/server.go +++ b/server/server.go @@ -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(