Getting Started

Voordat je aan de slag kunt zijn er een paar software dingen die je nodig hebt:

• Git
• Node.js
• Yarn
• Docker
• Editor
• Plugins

Git

Installeer git.
Volg deze guide om je git goed in te stellen.

Nodejs

Om snel van start te kunnen gaan installeer de laatste LTS versie.
Om het gebruik van nieuwere versies van nodejs in de toekomst makkelijker te maken kun je NVM (Node Version Manager) installeren.

Yarn

We gebruiken Yarn als onze package manager. Volg de installatie stappen aangegeven op de Yarn website.

Docker

Installeer Docker Desktop.
Deze stap is heel simpel voor Linux en MacOS gebruikers maar kan voor heel veel gezeik leiden voor Windows gebruikers.
Een mogelijke oplossing is deze command runnen in je favoriete console:

wsl --update

Heeft dit niet gewerkt?
Sucks to be you. Installeer Linux of het is Googlen geblazen.

Editor

Dit is puur je voorkeur maar uit ervaring blijkt dat Webstorm (en PHPStorm) heel slecht omgaat met Vue types. Onze keuze is daarom Visual Studio Code.

Plugins

Dit project maakt gebruik van de Javascript framework 'Vue' en andere mooie packages die ons leven makkelijker maken.
Voor VSCode (en andere) zijn hiervoor plugins gemaakt om onze developer experience te verbeteren.

Zorg dat deze plugins geïnstalleerd zijn:

• Volar
• Volar Typescript
• Prisma

Zeer aangeraden plugins:

• Github copilot
• Prettier
• Tailwind CSS IntelliSense

Vue heeft ook een handige devtools extensie voor je browser:

• Chromium
• Firefox
• Safari (Work in progress)

Aan de slag

Als het goed is ben je klaar om aan dit project te gaan werken.
Clone dit project in je favoriete mapje met de volgende command:

git clone https://github.com/Proteus-Eretes/mijn-proteus.git

Open vervolgens het project in je editor.
De meeste editors hebben een ingebouwde console waarin je je commands kunt typen.
Eerst moeten we alle packages installeren die we gebruiken in ons project:

yarn

Als dit klaar is moeten we extra infrastructuur installeren en opstarten.
Hiervoor gebruiken we dus Docker.

docker compose -D up

Als je bij je Docker Desktop kijkt onder het kopje 'Containers' staan er een aantal dingen (database, mailcatcher, etc).
Nu kunnen we de app zelf voorbereiden:

yarn migrate-dev

yarn seed

En vervolgens opstarten:

yarn dev

Als het goed is draait de app nu lokaal op je machine en kan je hem bezoeken op http://localhost:3000
(De poort kan anders zijn: 3001, 24679, of iets anders. Dit staat dan aangegeven in je console)