diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 83 |
1 files changed, 59 insertions, 24 deletions
@@ -1,25 +1,60 @@ -Installasjonsveiledning -======================= - -Denne webapplikasjonen er laget ved hjelp av [RefineryCMS][1] som igjen er -bygget på [Ruby on Rails][2]. Litt kjenskap til Ruby on Rails er alltids greit å -ha, men for mange oppgaver kan man fint klare seg uten. - -Komme i gang ------------- -For å komme i gang trenger du en fungerende versjon av [Ruby][3] (helst versjon -1.9.3 eller bedre) og [Bundler][4] installert. I tillegg trenger du en -JavaScript-motor. [NodeJS][5] anbefales, da den ikke krever noe annet oppsett -enn å være installert. - -Er alt dette på plass kan du configurere utviklingsmiljøet ditt ved å kjøre -`script/setup`. Det vil installere alle avhengigheter applikasjonen har og sette -opp databasen som applikasjonen bruker. Dette er i utgangspunktet en tom -database med kun noen veldig få eksempelsider lagt inn. - -[1]: http://www.refinerycms.com -[2]: http://www.rubyonrails.org -[3]: http://www.ruby-lang.org -[4]: http://www.bundler.org -[5]: http://www.node.js +# Installasjonsveiledning +Denne webapplikasjonen er laget ved hjelp av [RefineryCMS][1] som igjen er bygget på [Ruby on Rails][2]. Litt kjenskap til Ruby on Rails er alltids greit å ha, men for mange oppgaver kan man fint klare seg uten. + +## Oppsett av utviklermiljø + +Vi bruker [Vagrant] for å gjøre det enkelt å sette opp et utviklermiljø som er mest mulig likt det som vi finner på serveren vi kjører på. + +Du trenger: + +* [VirtualBox] +* [Vagrant] +* [Git] +* En teksteditor. + +Sørg for at disse programmene er installert på din maskin. + +### Kopier koden: + + % git clone https://volse.anduin.net/gitrepos/hmnoweb.git + +### Last ned og start utviklermiljøet + + % cd hmnoweb + % vagrant up + +Dette vil ta noe tid første gang. Det laster ned en virtuell maskin og installerer alt du trenger på den. Når denne prosessen er ferdig kan du åpne en terminal for den virtuelle maskinen: + + % vagrant ssh + +Du vil finne kildekoden til programmet i `/vagrant`-katalogen. Du kan gå dit og sette opp selve applikasjonen slik: + + % cd /vagrant + % script/setup + +Du kan så starte serveren slik: + + % bundle exec rails server + +Du skal nå få opp en rimelig tom utgave av heavymetal.no dersom du går til `http://localhost:3000` i nettleseren din. + +### Logge inn og administrere sidene + +Du logger inn og kan administrere din lokale kopi av heavymetal.no ved å gå til `http://localhost:3000/refinery`. I utviklermodus har vi laget en eksempelbruker du kan bruke med brukernavn `admin` og passord `test`. + +### Synkronisere endringer + +Når du har gjort endringer i koden, må du synkronisere disse med vagrant-miljøet. Dette gjør du slik: + + % vagrant rsync + +Evt kan du kjøre `vagrant rsync-auto`, som vil synkronisere filene så snart de blir endret. Kjører du denne kommandoen i en egen terminal skal filene synkroniseres når du lagrer dem i teksteditoren din. Det gjør det enkelt å teste ut endringer ganske kjapt. + +De fleste endringer krever ikke at du stopper og starter serveren på nytt. Dersom du gjør endringer i konfigirasjonen av applikasjonen (nærmest hva som helst under `./config`-katalogen i kodetreet) så må du starte serveren på nytt. Det gjør du enklest ved å gå til terminalen hvor du har vagrant-miljøet ditt kjørende, trykk `CTRL-C` for å stoppe serveren, og så kjør `bundle exec rails server` på nytt. Vanligvis finner du linjen raskest ved å trykke pil opp på tastaturet. + +[1]: https://www.refinerycms.com +[2]: https://www.rubyonrails.org +[Vagrant]: https://www.vagrantup.com/ +[VirtualBox]: https://www.virtualbox.org/ +[Git]: https://git-scm.com/ |