Development manual

Þróunarskýrsla

Þessi skýrsla er leiðarvísir sem hugsuð er til að leiðbeina nýjum meðlimum í þróunarstarfinu. Hér kemur fram hvaða hugbúnaður þarf að vera til staðar á tölvum þeirra.

Notandi þarf að hafa aðgang að:

GitHub - Aðgang er hægt að stofna á síðu GitHub. Notanda er svo bætt í gagnageymslu (e. repository) hópsins.

Skel - Macintosh og unix notendur geta notað innbyggðu skelina í vélinni sinni. Forritarar sem vinna á Windows vél þurfa annaðhvort að ná í Powershell á GitHub eða Putty. Til að skrá sig inn á greencloud vélina þarf að nota ip tölu vélarinnar - 46.149.26.47.

Java - Útgáfu 1.7 eða nýrri af Java, hana er hægt að sækja hér. (Macintosh notendur notist við nýjustu útgáfu). Ef viðkomandi ætlar að vinna á powershell þá þarf hann að hægri smella á computer, fara í advanced system properties → environment variables → system variables fara í path og líma í reitinn fyrir variable value slóðina á staðinn sem java skráin var vistuð.

Inn í environment variables þarf svo að fara í user variables for user og bæta við nýjum variable sem heitir JAVA_HOME og setja sama path inní value þar.

Git - Leiðbeiningar til að setja upp git er að finna hér.

Maven - Maven 3.1.1 er hægt að sækja hér.

Ef viðkomandi ætlar að vinna á powershell þá þarf hann að hægri smella á computer, fara í advanced system properties → environment variables → inni í system variables þarf að fara í path og vista slóðina þar sem maven er vistað í reitinn variable value.

Inni í environment variables þarf svo að fara í user variables for user og bæta við nýjum variable sem heitir MAVEN_HOME og setja sömu slóð inn í value þar.

Tengjast GitHub með SSH lykli:

Opna skel og slá inn skipunina $ ssh-keygen . Engar upplýsingar þarf að slá inn nema notandi vilji. Þá er búinn til private og public lykill.
$ cd .ssh til þess að færa sig inní .ssh möppuna, hún sést ekki og þarf því að gera $ cd .ssh
$ cat id_rsa.pub - þessi skipun birtir public lykillinn sem við afritum.
Svo er farið inn á GitHub þar sem lykilinn er vistaður, vinsamlegast veljið lýsandi nafn fyrir lykilinn.
Notandi sækir gagnageymslu (e. repository) qts með því að afrita SSH clone slóðina með því að keyra skipunina $ git clone git@github.com:qts/lateterm.git

Listi yfir skipanir sem eru notaðar til að keyra og prófa kóðann, þær verða skilgreindar á ensku:

Skipanir:	./bin/.. keyra eftir farandi skipanir:
./bin/run	export PORT=4567 Spark runs on port 4567 java -jar target/lateterm-1.0-SNAPSHOT-jar-with-dependencies.jar makes a .JAR file with dependencies
./bin/compile	mvn compile Compile the source code of the project.
./bin/package	mvn package Take the compiled code and package it in its distributable format, such as a JAR.
./bin/build_and_test	mvn clean test Test the compiled source code using a suitable unit testing framework. These tests should not require the code be packaged or deployed. Then creates the code coverage report for unit tests to the directory target/site/jacoco-ut. mvn package Take the compiled code and package it in its distributable format, such as a JAR. mvn checkstyle:checkstyle Generates the Checkstyle report by explicitly executing the checkstyle:checkstyle goal from the command line. java -jar target/lateterm-1.0-SNAPSHOT-jar-with-dependencies.jar makes a .JAR file with dependencies
Skipanir	lýsing
mvn clean	Remove all files generated by the previous build
mvn test	Run tests using a suitable unit testing framework. These tests should not require the code be packaged or deployed.
call mvn (...)	Call before mvn- mvn itself is a batch file and batch files need to call each other with call
mvn verify	Run any checks to verify the package is valid and meets quality criteria, with maven
mvn install	Install the package into the local repository, for use as a dependency in other projects locally
deploy	done in an integration or release environment, copies the final package to the remote repository for sharing with other developers and projects.