rh_styleguide/README.md

Styleguide for Region Halland

# Region Halland Styleguide

## Kom igång

1. Kör `yarn` i terminalen för att ta hem alla dependencies.
2. Kör `yarn storybook` för att se dokumentationen.

## Reposets struktur

### /.storybook

I denna folder finns alla config filer för storybook

### /docs

Här skriver vi vår design dokumentation, dvs. våra Storybook stories.

### /src

Här producerar vi vår Stilguide. All JS, Tailwind CSS och eventuellt övriga assets ligger här.

### /node_modules

Här ligger alla våra dependencies. Ändra aldrig några filer i denna mappen då den skrivs över när vi kör `yarn`.

### .prettierrc

Denna filen definierar vår konfiguration av Prettier.

### .stylelintrc.json

Denna filen definierar vår konfiguration för hur CSS bör skrivas. I princip nyttjar denna Prettiers default conf.

### package.json

Alla våra dependenices och info om projektet

### postcss.config.js

Innehåller en standard conf för styleguiden som vi sedan kan nyttja i våra olika teman. Observera att Storybook kör sin egna konfiguration av PostCSS.

### tailwind.config.js

Styleguidens konfiguration av tailwind. Här anger vi alla variabler osv. Denna konfiguration läses in av Storybook och bör vara den som alla teman utgår från

### tsconfig.json

Konfigurationsfil för hur Typescript ska kompileras

### tslint.json

Denna filen definierar vår konfiguration för hur Typescript bör skrivas. I princip nyttjar denna Prettiers default conf.