Dokumentation är ju bra, men den kommer ju (beviserligen, enligt definition, och beviset lämnas som en uppgift till läsaren) inte uppdateras om den ligger i ett annat repo :^)
Konglig Datasektionens API-specifikationer
För att lägga till en API-specifikation måste ändringar göras både i frontend och backend. Utöver detta måste du också redigera API-specifikationsfilen för duckumentation 💯 Denna finns under server/specifications/duckumentation.yml
.
- Lägg till OpenAPI-specifikationsfilen i
server/specifications
.
I client/src/App.js
, gör fäljande:
- Lägg till ett objekt i
links
-arrayen:{ label: "Label", to: "/path", api: "/api/apipath" }
/api/apipath
ska vara den path:en som definierades på backenden.to
s värde måste vara unik
Redigera specifikationsfilen du vill ändra och gör en PR. Specifikationsfilerna ligger under server/specifications
.
Redigera .env.development
-filen under client/
för att definiera miljövariabler.
Namn | Standardvärde | Beskrivning |
---|---|---|
REACT_APP_BASE_URL | http://localhost:5000 | Path till backenden |
Skapa en .env
-fil under server/
för att definiera miljövariabler.
Namn | Standardvärde | Beskrivning |
---|---|---|
NODE_ENV | development | - |
PORT | 5000 | - |
Detta system beror inte på något annat system. Detta system har inga pls-permissions.
- Klona detta repo
- Installera dependencies
- Under
client/
, kör:npm install
- Under
server/
, kör:npm install
- Under
- Kör frontend
- Under
client/
, kör:npm start
frontenden serveras på http://localhost:3000
- Under
- Kör backend
- Under
server/
, kör:npm run dev
backenden serveras på http://localhost:5000
- Under
- Klona detta repo
- Installera dependencies
- Under
client/
, kör:npm install
- Under
server/
, kör:npm install
- Under
- Bygg frontend
- Under
client/
, kör:npm run build
- Under
- Kör backend
- Under
server/
, kör:npm start
- Under
Backenden serveras på port 5000 om inget annat är angett.
Frontenden serveras på /
, API:et på /api/...