Onderhoud en Beheer van Code Projecten

We gaan ervan uit dat je al een project hebt. Zoals een project uit het Open Data / Api Project. Heb je geen eigen project, dan gebruik je de SPL-oefenopdrachten als casus om te oefenen met de updates.

SPL Opdrachten als Eindtoets

Heb je geen eigen code, dan moet je de onderstaande opdrachten toepassen op je oefenopdrachten. Je docent kan je vorderingen volgen via github. Aan het einde van het project moet je, in plaats van een presentatie, een theorie-toets maken over de algoritmes in de kaartenbak. Je moet alle algoritmes kennen en met pen en papier 2 opdrachten maken in 50 minuten.

Stap 1. Ga op Github en upload je eerste versie

Binnen de Github-Organisatie Techniek College Rotterdam kun je onbeperkt private repo\’s aanmaken. Eentje is nu even genoeg. Voeg ook je teamleden toe aan het projectteam. Je moet hier online gaan samenwerken, dus ieder een eigen account.

Let op bij het uploaden van je code erop dat je geen password files of API KEYS meestuurt. Je kunt de file deleten, maar de inhoud blijft voor eeuwig in de repo plakken. Beter niet mee uploaden. Bedenk een truc.

Stap 2. Maak een Readme

Schrijf in het Markdown formaat de pagina Readme.md. Let op deze onderdelen:

  • Wat is de bedoeling (Use Case) van je project
  • Hoe installeer je het ? In stappen netjes uitwerken. Je kunt ook een evt. installer file toevoegen. Dat kan ook gescript in een github page.
  • Roadmap. Welke inhoudelijke plannen heb je zelf. Graag 3-5 items.

Stap 3. Als alles misgaat

In je code ga je er vaak vanuit dat vooronderstellingen kloppen. Je code werkt bijv. alleen als de API key wordt geaccepteerd. Als de database connectie / query werkt en resultaat geeft. Identificeer minstens 3 van deze aannames en maak deze nu eerst als test in de code. Hoe vang je de fout af, als deze optreedt ?

Stap 4. User Interface

Maak een aantal verbeteringen aan de interface waardoor deze op het niveau netjes / fatsoenlijk komt. Een cli-script kan ook een fatsoenlijke interface hebben. Een webpage ook. Hoe van je onjuiste invoer af ?

Stap 5. Code Standards

De opmaak van je code is nog wel eens een issue. Zoek op welke code standaarden er worden gehanteerd voor jouw taal. En maak de nodige wijzigingen. Geen troep code aub. Mede-ontwikkelaars knappen af als jij het niet netjes maakt.

Stap 6. Internationalization

Gebruik GNU Gettext (PHP Gettext, GNU Gettext for Java) om teksten die nu in het Nederlands / Engels zijn, taal-onafhankelijk te krijgen. Met Gettext heb je een platform om taal-onafhankelijk te zijn. Succes !

Pro Steps. Heroku of Travis

Heroku en Travis zijn tools rond Github waar je gebruik van kunt maken. Kies 1 van de 2 (beiden kan ook). Met je studenten-github account heb je voor beiden al een account / tegoed via het Github Education Pack.

Travis is “The home of open source testing”. https://travis-ci.org/

Heroku is a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud. https://www.heroku.com/

Maak na enig onderzoek een bewuste keuze voor Heroku of Travis (waar heb je behoefte aan) en documenteer de stappen en keuzes die je maakt op dit platform.