đ ïž SĂ€tt upp utvecklingsmiljön
Klona repot och vÀlj ett av alternativen nedan.
git clone https://github.com/migrationsverket/midas.git
đł Docker (Rekommenderat)â
Det snabbaste sÀttet att komma igÄng Àr med Docker. DÄ behöver du inte installera Node.js, npm eller nÄgra beroenden lokalt - allt körs i en isolerad miljö med exakt rÀtt versioner.
Krav: Endast Docker Desktop (eller Docker Engine + Docker Compose)
Startaâ
docker compose up -d
Detta startar i bakgrunden:
- Storybook pÄ http://localhost:4400
- Dokumentation pÄ http://localhost:3000
- Playground pÄ http://localhost:4200
- Next.js pÄ http://localhost:3001
Starta en specifik app:
docker compose up -d storybook # Endast Storybook
docker compose up -d docs # Endast dokumentation
Kör kommandonâ
docker compose exec midas-cli npx nx test components # Kör tester
docker compose exec midas-cli npx nx build components # Bygg komponenter
docker compose exec midas-cli npm install <paket> # Installera beroenden
docker compose exec midas-cli sh # Ăppna shell i containern
Stoppaâ
docker compose down
Felsökningâ
Port redan upptagen: Stoppa processen som anvÀnder porten, eller Àndra portmappning i docker-compose.yml.
Ăndringar syns inte: Kontrollera loggarna med docker compose logs -f <service> eller starta om med docker compose restart <service>.
Bygga om efter beroendeÀndringar:
docker compose down
docker compose build --no-cache
docker compose up -d
Ren omstart:
docker compose down -v
docker compose build --no-cache
docker compose up -d
đ» Lokal installation (Alternativ)â
Om du föredrar att köra allt lokalt behöver du:
Node version ^24 krÀvs. Installera Nx globalt: npm install --global nx@latest
Nxâ
Midas Àr ett monorepo som hanteras med Nx. Det innebÀr att vi har flera olika projekt i samma repo, till exempel komponentbiblioteket, dokumentationswebben och andra verktyg. Du kan köra nx graph för att se en visuell representation av hur projekten Àr relaterade till varandra.
Starta Storybookâ
nx serve storybook
Komponentbibliotekâ
Alla komponenter ligger under /packages/components och exporteras som ett npm-paket @midas-ds/components.
Testerâ
nx test components
Mer info finns pÄ sidan om tester.
Dokumentationswebbâ
Dokumentationswebben ligger i apps/docs och Àr byggd med Docusaurus.
nx serve docs # Kör lokalt
nx build docs # Produktionsbygge
đ§Ș Testa lokalt end-to-endâ
För att testa komponentbiblioteket i en annan app kan du publicera det till ett lokalt Verdaccio-registry.
Publicera till lokalt registryâ
Med Docker:
docker compose up -d verdaccio
docker compose exec midas-cli npx nx run @midas-ds/source:release:local:docker:dev
Utan Docker:
nx run @midas-ds/source:release:local:dev
Installera i ditt testprojektâ
npm install @midas-ds/components@latest --registry=http://localhost:4873/
đ Fördjupningâ
- Arkitektur - VÄr designfilosofi och val av beroenden
- Arbetsflöde - Commit-format och versionshantering