regionhalland/region-halland-theme-boilerplate

Region Hallands starttema. Använd detta tema som en grund för utveckling av nya teman

v3.0.0 2021-11-24 10:32 UTC

README

För alla Wordpress webbar använder Region Halland delar av Roots stacken, primärt Bedrock och Sage. Fördelarna med denna stack är många men en av de största fördelarna är att vi kan nyttja Composer för att hantera de paket vi nyttjar, bl.a. är alla egenutvecklade plugins paket som hämtas via Composer.

Så här utvecklar du ett nytt tema för Region Halland

Förutsättningar 🚨

  • Du har en lokal utvecklingsmiljö uppsatt, t.ex. Homestead eller MAMP
  • Du följande paket installerat:
    • Composer
    • Yarn
    • Azure CLI (se nedan)
    • Node.js version 8.x. Vår version fungerar inte med nyare versioner av Node. Använd NVM för att hantera flera lokala versioner av Node.js

Installera Bedrock

  1. Ta först hem vårt boilerplate för Bedrock genom att köra composer create-project regionhalland/region-halland-site-boilerplate <NAMNET PÅ FOLDERN DU VILL SKAPA PROJEKTET I> och följ installationsinstruktionerna för bedrock.

Konfigurera GIT

  1. Navigera till /web/app/themes/. Här ligger den senaste versionen av vårt boilerplate. Dvs. detta paket.
  2. Byt namn på mappen region-halland-theme-boilerplate till namnet på ditt tema. Alla våra teman namnges med region-halland-theme-<NAMNET_PÅ_DITT_TEMA>.
  3. Sätt på versionhantering för temat genom att gå in i din tema mapp och skriv
     git init .
    
  4. Gör din första commit genom att skriva
     git add --all
     git commit -m "first commit of my code"
    
  5. Bra! Nu har du lokal versionhantering påslaget, nu lägger vi till en remote på Azure så att koden går att dela med kollegorna. Första steget är att installera Azures CLI och logga in med AZ
  6. Lägg till ett repos i Azure genom att skriva
     az repos create --project public.RhWpSites --name RhTheme<NAMNET_PÅ_DITT_TEMA>
    
  7. Efter att ovanstående kommando körts så returneras ett array med info i terminalen, leta upp "remoteUrl" och kopiera den adressen.
  8. Skriv sedan
     git remote add origin <DIN_REMOTE_URL>
    
  9. Sista steget är att pusha din kod! 🎉
     git push origin master
    

Konfigurera temat

  1. Eftersom vi skapar ett nytt tema så behöver vi uppdatera temats package.json och composer.json.
    1. Öppna package.json och ändra "name", "version", "author".
    2. Öppna composer.json och ändra "name", "description".
  2. När du uppdaterat uppgifterna i JSON filerna så kan du installera temat genom att köra två kommandon:
     composer install
     yarn
    
  3. Förutsatt att du satt upp en lokal utvecklingsserver, t.ex. MAMP eller Homestead, så kan du nu köra yarn start för att kicka igång temat och få en lokal URL med Browsersync o.d. Se package.json för övriga kommandon.

Tips för utveckling av temat

  • 🔌 Tänk på att vi har över 100 plugins som levererar funktioner till våra teman. Troligtvis har vi redan byggt det du behöver, kontakta oss på webbplatser@regionhalland.se så kan vi hjälpa dig. Merparten av våra plugins finns som separata paket på packagist.org
  • 🖼 Alla våra gränssnitt ska nyttja vår digitala stilguide. Som standard så inkluderas denna via NPM i våra teman och byggs med webpack (se resources/assets/build/webpack.config.*). Ta del av stilguiden på stilguide.regionhalland.se.

Versionhistorik

Se https://regionhalland.visualstudio.com/public.RhWpSites/_git/RhThemeBoilerplate/tags