/sangbok

Webapp for speidere som ønsker å finne fram til speidersangene rundt leirbålet

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

Sangbok Logo

Illustrasjon av Freepik Storyset

Sangbok

CI status

En webapp for fremvisning av speidersanger. Appen lar deg spille av sanger, både fra Spotify og egenopplastede. Videre er innholdet tilgjengelig offline, og den tilhørende darkmoden gjør teksten godt leselig i nattens mulm og mørke.

Wiki

Brukermanualer, utdypende informasjon mm. finnes på prosjektets wiki.

Prosjektstruktur

Applikasjonen er bygget med Sanity.io og Next.js. Sanity håndterer opprettelse, lagring og uthenting av sanger, Next.js viser frem innholdet.

Mappen frontend/ inneholder all kode relevant for applikasjonens utseende og funksjonalitet. Mappen cms/ inneholder all kode relevant for dataen som vises frem og dens struktur. Både frontend/ og cms/ er to frittstående prosjekter, - de kan med andre ord kjøres uavhengig av hverandre. Det er dog verdt å nevne at frontend-appen belager seg på data fra cms, så dersom cms ikke kjører i bakgrunnen vil dataen mangle.

Utvikling og oppsett

For å kunne kjøre en utviklingsinstans av webapplikasjonen så trenger man: Node.js og yarn.

Vi anbefaler VSCode for utviklingsprosessen. Den er lett å bruke, gratis og fungere flott out of the box.

For å kjøre prosjektet, følg README.md som ligger i frontend/ og cms/-mappene. Disse filene inneholder informasjon om oppsett, tilgjengelige funksjoner og scripts.

Under utvikling anbefales det å åpne frontend/ og cms/ i egne VSCode-instanser for et best mulig utviklermiljø.