googol / drinkkiarkisto

Sovellus drinkkireseptien tallentamiseen

Home Page:https://peaceful-scrubland-8625.herokuapp.com/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

drinkkiarkisto Build Status Dependency Status Heroku

Yksinkertainen web-sovellus drinkkireseptien tallentamiseen ja etsimiseen.

Tehty alunperin Helsingin Yliopiston tietojenkäsittelytieteiden Tietokantasovellus-kurssin harjoitustyönä.

Tehtävänanto

Tämä harjoitustyö perustuu valmiiseen drinkkiarkisto-aiheeseen. Aiheen kuvaus: http://advancedkittenry.github.io/suunnittelu_ja_tyoymparisto/aiheet/Drinkkiarkisto.html

Demoinstanssi

Tämänhetkinen kehitysversio pyörii osoitteessa: https://peaceful-scrubland-8625.herokuapp.com/

Dokumentaatio

Dokumentaatio kootaan dokumentaatio.pdf-tiedostoon demoinstanssissa

Kehitysympäristö

Ohjelmiston kehitysympäristönä voit käyttää vagrantia. Asenna vagrant sekä virtualbox, ja aja vagrant up projektikansiossa. Tämä luo virtuaalikoneen jossa voit ajaa ohjelmaa. Komennolla vagrant ssh saat yhteyden virtuaalikoneeseen, jossa voit komennolla npm start käynnistää serverin. Serveri on tavoitettavissa osoittessa http://localhost:3000/ niin virtuaalikoneella kuin hostilla. Jotta selainjavascript toimisi, on ennen serverin käynnistystä ajettava npm run bundle joka kääntää selaimelle sopivan javascript-paketin. Kehityksessä voi käyttää npm run bundle watch-komentoa joka kääntää automaattisesti paketin kun lähdekoodiin tallennetaan muutoksia.

Koodin rakenne

  • .editorconfig
  • .travis.yml
  • Vagrantfile
    • Vagrant-kehitysympäristön konfiguraatio
  • bootstrap.js
    • Koodin entry-point. Initialisoi babelin joka kääntää es6-koodia vanhempaan syntaksiin.
  • doc/
    • Dokumentaation lähteet
  • scripts/
    • Apuriskriptejä kehitysympäristöön
  • sql/
    • Sql-skriptit mm. tietokannan, taulujen ja testidatan luontiin, sekä niiden poistamiseen
  • src/
    • Lähdekoodi ohjelmistolle.
  • src/controllers.js
    • Serverin controllerien moduuli. Kokoaa src/controllers-kansiossa olevat luokat yhteen.
  • src/controllers/
    • Serverin controlleriluokat erillisissä tiedostoissa.
  • src/data.js
    • Tietokantayhteyksien moduuli. Kokoaa src/data-kansiossa olevat luokat yhteen.
  • src/data/
    • Tietokantayhteyksien luokat yksittäisissä tiedostoissa.
  • src/middleware.js
    • Serverin middelewaret. Julkaisee serverin reiteille omia middlewareja, sekä funktion joka lisää serverin yleiset middlewaret serverille.
  • src/routes.js
    • Serverin reititystiedot.
  • src/server.js
    • Serverin päätiedosto. Konfiguroi serverin ja käynnistää sen.
  • src/validation.js
    • Serveripään datavalidoinnin moduuli. Kokoaa src/validation-kansiossa olevat luokat ja funktiot yhteen.
  • src/validation/
    • Luokkia ja funktioita datan validoimiseen serverissä.
  • src/views/
    • Näkymät ejs-templateina
  • vagrant/
    • Konfiguraatiotiedostoja kehitysympäristöön

About

Sovellus drinkkireseptien tallentamiseen

https://peaceful-scrubland-8625.herokuapp.com/

License:MIT License


Languages

Language:JavaScript 83.5%Language:PLpgSQL 15.2%Language:Shell 1.3%