From ac5c2bcd27e23d09f0b072984ac2901d682443c4 Mon Sep 17 00:00:00 2001
From: Axel Froborg <axel.froborg@gmail.com>
Date: Sat, 7 Oct 2023 15:00:56 +0200
Subject: [PATCH] update readme

---
 README.md           | 98 +++++++++++++++++++++++++++++----------------
 strapi/.env.example |  7 ----
 web/.env.example    |  4 +-
 3 files changed, 65 insertions(+), 44 deletions(-)

diff --git a/README.md b/README.md
index 99dc75b..763126d 100644
--- a/README.md
+++ b/README.md
@@ -2,58 +2,88 @@
 
 Repo för Nollningshemsidorna [`nollning.esek.se`](https://nollning.esek.se) och <s title="deprecated since 2022">[`e-nollning.nu`](https://e-nollning.nu)</s> samt alla alias `/\d{4}/.nollning.esek.se`.
 
+## 📚 Struktur
+
+Projektet består av två delar. En backend server och en frontend applikation.
+
+### Backend
+
+Backenden består av ett [Strapi CMS](https://strapi.io/) som hanterar allt innehåll på sidorna. Mer information om backenden finns [här](./strapi/README.md).
+
+### Frontend
+
+Frontenden är en [Next.js](https://nextjs.org/) applikation som hämtar data från [backenden](#backend) och renderar sidorna serverside. Mer information om frontenden finns [här](./web/README.md).
+
 ## ⚡️ Quickstart
 
 För detta projektet krävs:
 
 - [Docker](https://www.docker.com/)
 - [NodeJS](https://nodejs.org/)
-- [Yarn](https://yarnpkg.com/) (går att installera med `npm install -g yarn`)
+- [Yarn](https://yarnpkg.com/)
 
-### Lokal dev miljö
+### 🐘 Postgres
 
-För att starta en lokal devmiljö behöver du först klona projektet. Om [Docker Desktop](https://www.docker.com/products/docker-desktop/) används, starta denna applikation. Se till att det **inte** finns några docker images som kör på port 5050 och 5432. Kör därefter `docker compose up` i root för att starta en `nollesite` container.
+Skapa en lokal postgres instans. Det finns en docker-compose fil i root som kan användas för detta:
 
-Följande steg förklarar hur en strapi instans skapas, där du kan redigera nollningssidor. Därefter förklaras hur man skapar en lokal webapplikation för att testa nollningssidorna.
+```bash
+# ./
+docker compose up
+```
 
-#### ⚙ Strapi
+### ⚙️ Strapi
 
-Skapa CMS:et på följande sätt:
-1. Skapa en `.env`-fil i `strapi/` och kopiera över innehållet från `.env.example`. Inga ytterligare ändringar behöver göras för att få lokala strapi-instansen att fungera. I testing används variablerna för följande syften:
-   - `DB` - värdena för lokala postgres-instansen
-   - `STRAPI_HOST` och `STRAPI_PORT` - adressen som servern kör på
-   - `SMTP` - för att testa skicka mejl lokalt, exempelvis för att testa funktionaliteten för att ha glömt sitt lösenord
-   - <s title="deprecated">`WIKI` - används för att kunna visa en sida från DDGWikin i Strapi</s>
-2. `cd strapi`, `yarn install` och `yarn dev`
-3. En lokal strapi instans kommer startas på http://localhost:8000
-4. Skapa ett lokalt konto
-5. Ett [nollningsår kan nu skapas](https://ddgwiki.esek.se/index.php/Nollningshemsidan)!
+1. Kopiera `.env.example` till `.env` i [`/strapi`](./strapi)
 
-#### 🚀 Web
+   ```bash
+   # ./strapi
+   cp .env.example .env
+   ```
 
-Skapa en lokal webapplikation för nollningssidorna på följande sätt:
-1. Skapa en `.env`-fil i `web/`
-   - Kopiera över innehållet från `.env.example`
-   - Fyll i `.env`-filens `STRAPI_API_TOKEN`. Värdet för denna är en API Token som skapas i lokala Strapi instansen, på http://localhost:8000/dashboard/settings/api-tokens
-   - Lägg till `GOOGLE_API_KEY` om kalendern ska testas. Denna nyckeln finns också i Bitwarden
-2. `cd web`, `yarn install` och `yarn dev`
-3. En lokal webapplikation kommer startas på http://localhost:3000
+   Uppdatera värden i `.env` enligt instruktionerna i [filen](./strapi/.env.example).
 
-#### ❓ Felsökning
+2. Installera dependencies:
 
-Några vanliga fel som kan uppstå när en lokal dev miljö skapas, och lösningar som har upptäckts för dessa, är följande:
-- Om inte yarn-kommandon fungerar i terminalen kan [nvm](https://github.com/nvm-sh/nvm) användas för att byta version av node med `node use <version>`. Efter detta brukar yarn-kommandon fungera igen.
-- Om inte en docker container har skapats när `yarn dev` används i `strapi` kan CMS:et ladda för evigt. Se då till att stänga ner strapi instansen i terminalen med <kbd>CTRL</kbd> + <kbd>C</kbd>. Sedan kan `docker compose up` köras i root. När `yarn dev` körs igen borde CMS:et startas som tänkt.
-- Om ett nollningsår är skapat i CMS:et men inte dyker upp i webapplikationen - se till att nollningsåret har en svensk locale. Detta är egentligen en bugg, i issue https://github.com/esek/nollesite/issues/25.
+   ```bash
+   # ./strapi
+   yarn install
+   ```
 
-## 📚 Struktur
+3. Starta en lokal strapi instans:
 
-Projektet består av två delar. En backend server och en frontend applikation.
+   ```bash
+   # ./strapi
+   yarn dev
+   ```
 
-### Backend
+En lokal strapi instans kommer startas på <http://localhost:8000>
 
-Backenden består av ett [Strapi CMS](https://strapi.io/) som hanterar allt innehåll på sidorna. Mer information om backenden finns [här](./strapi/README.md).
+3. Skapa ett lokalt konto
+4. Ett [nollningsår kan nu skapas](https://ddgwiki.esek.se/index.php/Nollningshemsidan)!
 
-### Frontend
+### 🚀 Web
 
-Frontenden är en [Next.js](https://nextjs.org/) applikation som hämtar data från [backenden](#backend) och renderar sidorna serverside. Mer information om frontenden finns [här](./web/README.md).
+1. Kopiera `.env.example` till `.env` i [`/web`](./web)
+
+   ```bash
+   # ./web
+   cp .env.example .env
+   ```
+
+   Uppdatera värden i `.env` enligt instruktionerna i [filen](./web/.env.example).
+
+2. Installera dependencies:
+
+   ```bash
+   # ./web
+   yarn install
+   ```
+
+3. Starta en lokal strapi instans:
+
+   ```bash
+   # ./web
+   yarn dev
+   ```
+
+En lokal instans kommer startas på <http://localhost:3000>.
diff --git a/strapi/.env.example b/strapi/.env.example
index bf743b3..d1aa450 100644
--- a/strapi/.env.example
+++ b/strapi/.env.example
@@ -18,10 +18,3 @@ SMTP_HOST=
 SMTP_PORT=
 SMTP_USERNAME=
 SMTP_PASSWORD=
-
-
-# Wiki information, used to load the documentation
-# on the startpage
-WIKI_URL=
-WIKI_USERNAME=
-WIKI_PASSWORD=
\ No newline at end of file
diff --git a/web/.env.example b/web/.env.example
index ccf4572..06b87cc 100644
--- a/web/.env.example
+++ b/web/.env.example
@@ -1,13 +1,11 @@
 STRAPI_URL=http://127.0.0.1:1337
 
 # En API-token från strapi som används för att hämta innehållet till sidan
-# Genereras på https://admin.nollning.esek.se/dashboard/settings/api-tokens
-# av en strapi-administratör (t.ex macapar@esek.se)
+# Genereras på http://{strapi-url}/dashboard/settings/api-tokens
 # bör rimligtvis också vara read-only
 STRAPI_API_TOKEN=
 
 # Nyckel som används för att hämta t.ex. google calendar information
-# I dagsläget används en nyckel kopplad till `macapar@esek.se` kontot i GCP/g-nollning:
 # https://console.cloud.google.com/apis/credentials
 GOOGLE_API_KEY=