Files
bookmanager/README.md
T
2026-10-22 21:00:25 +02:00

98 lines
5.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Bokplanerare
Webbaserat planeringsverktyg för författare. Flera böcker, var och en med karaktärer, husdjur, bostäder, platser, företag, lokaler, scenarier, relationer, arbetsscheman och kartor med markeringar.
- **Next.js 15** (App Router, TypeScript) med utseende från **Tabler**
- **PostgreSQL** via Prisma
- Inloggning med **Authentik** (OpenID Connect via Auth.js)
- Svenska och engelska i gränssnittet (växlas i sidomenyn)
- Kartor: riktig karta (Leaflet + OpenStreetMap) eller egen uppladdad kartbild per karta
## Starta för utveckling
```bash
docker compose -f docker-compose.dev.yml up --build
```
Öppna http://localhost:3000. Utan Authentik-inställningar visas en **utvecklarinloggning** (bara i utvecklingsläge, finns aldrig i produktionsbygget). Källkoden monteras in så ändringar slår igenom direkt.
Vill du testa mot din riktiga Authentik: kopiera `.env.example` till `.env`, fyll i `AUTHENTIK_*` och sätt `AUTH_DEV_LOGIN=false`.
Ändrar du `prisma/schema.prisma`:
```bash
docker compose -f docker-compose.dev.yml exec app npx prisma migrate dev --name beskrivning
```
Ändrar du `package.json`, starta om med `docker compose -f docker-compose.dev.yml up --build -V` så att beroendevolymen byggs om.
## Sätta upp Authentik
1. I Authentik: **Applications → Applications → Create with Provider**, välj **OAuth2/OpenID Connect**.
2. Client type **Confidential**. Under **Redirect URIs** lägg till (exakt match):
`https://din-adress.example.com/api/auth/callback/authentik`
(för lokal test mot Authentik: `http://localhost:3000/api/auth/callback/authentik`)
3. Scopes: `openid`, `profile`, `email`.
4. Kopiera **Client ID**, **Client Secret** och **OpenID Configuration Issuer** (slutar på `/application/o/<slug>/`) till `.env`.
## Produktion
```bash
cp .env.example .env # fyll i lösenord, AUTH_SECRET, AUTH_URL och AUTHENTIK_*
docker compose -f docker-compose.prod.yml --env-file .env up -d --build
```
- Appen lyssnar på port `APP_PORT` (standard 3000). Lägg en omvänd proxy med HTTPS framför och sätt `AUTH_URL` till den publika adressen.
- Databasmigreringar körs automatiskt vid varje start.
- Data ligger i Docker-volymerna `db-data` (databas) och `uploads` (bilder). Ta backup på båda, eller använd **Bokinställningar → Exportera som JSON** per bok.
- Hälsokontroll: `/api/health`.
## Mallar
Varje typ (karaktär, husdjur, bostad, plats, företag, lokal, utbildning, scenario) och relationer har en mall som styr vilka fält formuläret har. Standardmallarna är byggda efter Word-mallarna i `Mall/`:
| Word-mall | I appen |
|---|---|
| Karaktärsmall (lång och kort) | Karaktär. Den korta finns som knappen *Ladda kort mall* i mallredigeraren |
| Djurmall, Bostadsmall, Företagsmall, Lokalmall, Scenariomall | Husdjur, Bostad, Företag, Lokal, Scenario |
| Utbildningsmall | Utbildning |
| Relationsmall | Relation (öppnas från relationslistan eller från en posts sida) |
| Schema dag / natt | Scheman, vyn *Timrutnät* med Dag 06–18 och Natt 18–06 |
| Karaktärs-ID, Bostads-ID, Skiss-ID ... | Fältet *ID / kod* på alla poster (valfritt, sökbart) |
Uppgifter som i Word-mallarna är ID-listor (anställda, boende, elever, involverade karaktärer, ägare) görs i appen som **relationer** mellan poster, till exempel ”Jobbar på”, ”Bor på”, ”Elev på”, ”Involverad i”. Då kan du klicka dig mellan dem och se dem i relationsdiagrammet.
En relation kan ha fler än två deltagare, till exempel en vännergrupp: välj två i *Från* och *Till* och resten under *Fler deltagare*. Gruppen ritas som ett nav i diagrammet, och den visas på varje deltagares sida.
Under **Mallar** kan du ändra fält, ordning, rubriker och fälttyper (text, textruta, tal, datum, val, kryssruta, länk) per bok, eller klistra in en mall som JSON:
```json
[
{ "key": "nickname", "label": "Smeknamn", "type": "text", "section": "Grunduppgifter" },
{ "key": "mood", "label": "Läggning", "type": "select", "options": ["Glad", "Butter"] }
]
```
Ändrar du en mall försvinner ingen data: värden för borttagna fält finns kvar i databasen.
## Kartor
- **Riktig karta**: sök adress, klicka där markeringen ska sitta, koppla den till en bostad, lokal eller plats. Dra för att flytta. *Spara vy* minns utsnittet.
- **Egen kartbild**: ladda upp en bild (PNG/JPG/WebP/GIF, max 15 MB) och placera markeringar på den.
- Från en posts sida kan du gå direkt till *Placera på karta*.
- Kartplattor och adressökning hämtas som standard från OpenStreetMaps publika servrar, som är tänkta för lätt användning. För tyngre bruk, sätt `MAP_TILE_URL` och `MAP_GEOCODER_URL` till egen eller betald tjänst. Adressökningar skickas då från webbläsaren till den tjänsten.
## Struktur
```
prisma/ schema och migreringar
src/auth*.ts Authentik-inloggning (Auth.js)
src/actions/ server actions (skriv-operationer)
src/app/ sidor och API-routes
src/components/ gränssnittskomponenter (Tabler)
src/i18n/ sv.ts och en.ts
src/lib/templates.ts standardmallar och validering
```
Varje bok tillhör användaren som skapade den; andra inloggade användare kommer inte åt den.