aloittaminen.md

Table of Contents generated with DocToc

• Aloittaminen
  • Noden ajaminen laitoksen palvelimella
    • [Kapsi](#kapsihttpwwwkapsifi)
  • Noden ajaminen Herokussa
  • Sovelluksen rakenne
    • lib
    • index.js
    • Gruntfile.js
    • [package.json](#packagejsonhttppackagejsonnodejitsucom)
  • Yeoman
    • Gruntfilen luominen
    • Yeoman-generaattorit

Aloittaminen

*Such Node, so easy*

_{kuvan teki Firesong.}

Nodea pystyy ajamaan laitoksen users-palvelimella (users.cs.helsinki.fi). Mutta valitettavasti siellä ei voi käyttää websocketteja, koska laitoksen Apache ei tue websocketteja.

Siispä kannattaa ehkä katsoa Noden ajaminen Herokussa.

Noden ajaminen laitoksen palvelimella

• Lue ohjeet.
• Suorita wanna-htdocs.
• Luo tiedosto ~/htodcs/.htaccess.
• Luo uudelleenohjaus Apachelta Nodelle:

RewriteEngine On
RewriteRule ^(.*)$ http://TUNNUS.users.cs.helsinki.fi:PORTTI/$1 [P]

• Tunnus on oma AD-tunnuksesi ja portti on joku portti vaikka väliltä 30000 - 40000
  • Node-ohjelmasi tulee kuuntelemaan tätä porttia, ei porttia 80!
• Jos sinulla on jo jotain users-palvelimella, niin htaccess tiedoston voi lisätä myös alikansioon.
• Aseta oikeudet kotikansiolle, htdocsille ja htaccessille linkattujen ohjeiden mukaan.
• Nyt Noden pitäisi toimia, testaa suorittamalla node ja ajamalla seuraava ohjelma (korvaa PORTTI omallasi)

var http = require('http');
http.createServer(function (req, res) {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('Hello World\n');
}).listen(PORTTI);

• Nyt http://TUNNUS.users.cs.helsinki.fi/ pitäisi sanoa Hello World!

Huom. Sovellusta ei kannata laittaa htdocs-kansioon, kannattaa luoda sille oma kansio kotikansioon: mkdir ~/nodeprojunnimi

Kapsi

Samoja ohjeita voi soveltaa, jos haluaa ajaa Nodea Kapsilla. Kapsi tarjoaa ilmaisia internet-palveluja käyttäjilleen, jäsenmaksua vastaan siis.

Eli Node taas Apachen takana mod_rewritellä, mutta Noden joutuu asentamaan itse esimerkiksi nvm:n avulla.

Kapsille saa myös avoimia portteja websocketteja varten, pyytämällä ylläpidolta.

Noden ajaminen Herokussa

• Aloittaminen: https://devcenter.heroku.com/articles/getting-started-with-nodejs
• Websockettien käyttö: https://devcenter.heroku.com/articles/node-websockets
• Heroku-toolbelt -ohje https://github.com/mluukkai/WebPalvelinohjelmointi2014/blob/master/web/viikko1.md#sovellus-internettiin

Pull requesteja otetaan vastaan. Eli jos törmäät ongelmiin ja keksit ratkaisun, niin niitä saa lisätä tänne ja laittaa Githubissa pull requestin, paina vain edit-nappulaa. :)

Sovelluksen rakenne

Tässä on esimerkki pienestä projektistani NodePieSpy:sta.

├── example               # koodiesimerkkejä ohjelman käytöstä, ei välttämätön
│   └── example.js
├── lib                   # itse projektin koodit
│   ├── algorithms        # pieniä moduuleja, joita käytetään koodissa
│   │   ├── bfs.js
│   │   ├── cluster.js
│   │   ├── to-list.js
│   │   └── to-matrix.js
  ...
│   ├── analyser.js       # pääluokka, jossa suurin osa sovelluslogiikasta
│   ├── api.js            # express-frameworkkia käyttävä web-palvelin, joka tarjoaa HTTP API:n analyserille
│   └── parser.js         # pieni moduuli, jota analyser käyttää irkkilogien parsimiseen
├── test                  # testit, tietenkin
│   └── analyser.test.js
├── Gruntfile.js          # gruntfile, kuin makefile, kannattaa myös katsoa gulp, se on ehkä helpompi.
├── index.js              # pääohjelma, sitä ei laiteta lib-kansioon
├── package.json          # ohjelman metatiedot
└── README.md

lib

Tänne on tarkoitus laittaa pieniä moduuleja ja "luokkia", jotka toimivat järkevästi yhteistyössä.

index.js

Täällä on tarkoitus ladata lib-kansiosta tarvittavat ja käynnistää sovellus. Tänne ei ole tarkoitus kirjoittaa suurta määrää koodia.

Gruntfile.js

Grunt on task runner, eli sille kerrotaan mitä tehdä, jonka jälkeen se tekee sen. Esimerkiksi tehtäviä voi olla testien ajaminen, sovelluksen deployaaminen, dokumentaation generoiminen, jne.

Suosittelen myös tutustumaan Gulp:iin. Gulp on uudempi ja vaikuttaa yksinkertaisemmalta kuin Grunt, mutta siitä ei ole vielä paljoa kokemusta.

package.json

npm on Noden paketinhallintajärjestelmä, eli sillä hoidellaan sovelluksen riippuvuudet, jotka löytyy package.json-tiedostosta. Sinne kannattaa lisätä myös projektin metatietoja, niitä tarvitsee viimeistään, jos haluaa julkaista moduulin npm:ssä.

Yeoman

Yeoman on työkalu, jolla on tarkoitus nopeasti päästä liikkeelle projektin kanssa ilman, että täytyy käyttää tolkuttomasti aikaa alkutoimiin, kuten työkalujen asenteluun ja konffaamiseen.

Laitoksen palvelimella vaatii tosin vähän säätöä:

• Jotta voit asentaa npm-moduuleja "globaalisti"
  • npm config set prefix ~/npm
  • echo 'export PATH=$HOME/npm/bin:$PATH' >> ~/.bashrc
• Jotta Yeoman löytää asennetut generaattorit
  • echo 'export NODE_PATH=$NODE_PATH:$HOME/npm/lib/node_modules' >> ~/.bashrc
• Tämän jälkeen käynnistä komentorivi uudestaan.

Gruntfilen luominen

• Asenna Yeoman npm install -g yo
• Asenna gruntfile generaattori npm install -g generator-gruntfile
• Ellet ole jo projektihakemistossa cd nodeproju
• Suorita generaattori yo gruntfile
• Asenna luodut riippuvuudet npm install
• Asenna Grunt npm install -g grunt-cli

Yeoman generaattorimme loi meille valmiin Gruntfilen, jossa on valmiiksi jshint, nodeunit ja watch -toiminnot.

Voit testailla niitä kutsumalla grunt (suorittaa default-taskin) tai grunt jshint:

:~/nodeproju$ grunt
Running "jshint:gruntfile" (jshint) task
>> 1 file lint free.

Running "jshint:lib_test" (jshint) task
>> 0 files linted. Please check your ignored files.

Running "nodeunit:files" (nodeunit) task
Warning: 0/0 assertions ran (0ms) Use --force to continue.

Aborted due to warnings.

Yeoman-generaattorit

Kannattaa tutustua Yeomanin yhteisön tarjoamiin generaattoreihin ja etsiä sieltä kiva, millä pääsee nopeasti vauhtiin.