Hey, en welkom bij Viamigo

Leuk dat jij onze website wil bezoeken!

Wij zijn Viamigo, een nieuwe manier van reizen plannen. Bij ons plan je een reis in je eentje en ga je op vakantie met geïnteresseerden die samen met jou het avontuur willen aangaan. Wij stellen gebruikers in staat hun ideale reis samen te stellen en zich aan te melden voor andere reizen, om zo samen de wereld te ontdekken.

Op de website is het mogelijk om een reis te plannen. Tijdens het plannen geef je verschillende specificaties van de reis op, zoals land, budget, datum en activiteiten. Zodra de reis is aangemaakt, kunnen andere mensen zich inschrijven.

Om met een reis gematcht te worden, moet de gebruiker een account hebben. Het maken van een account bestaat uit standaardgegevens zoals naam, leeftijd en e-mail, maar ook uit vragen die je matchresultaten later kunnen beïnvloeden. Denk hierbij aan hoe avontuurlijk je bent, hoeveel interesse je hebt in cultuur en of je prikkelgevoelig bent of juist niet. Mensen met vergelijkbare scores worden eerder met elkaar gematcht.

Daarnaast biedt onze app de mogelijkheid om te filteren. Denk bijvoorbeeld aan de prijs van de reis, het land van bestemming en het aantal reizigers.

De gebruiker kan ervoor kiezen om een gematchte reis te accepteren of af te keuren. Afgekeurde reizen worden niet meer getoond. Geaccepteerde reizen worden opgeslagen in een favorietenlijst. In deze lijst kan de gebruiker de reizen opnieuw bekijken en met elkaar vergelijken. Als de gebruiker tevreden is, kan hij of zij zich inschrijven voor de reis. De maker van de reis heeft vervolgens de mogelijkheid om deelnemers te accepteren of te weigeren.

Door middel van het swipen van een reis bepaal je of een reis geschikt voor jou is. Zo bepaal jij zelf met welke reizen je wil matchen.

---

Website lokaal draaien

Wil jij onze website lokaal draaien? Dat is ook mogelijk. Met deze handleiding leggen wij je stap voor stap uit hoe je dit voor elkaar krijgt, ook als je hier nog geen ervaring mee hebt.

Voordat we beginnen, is het belangrijk dat je een codeprogramma op je laptop hebt staan. Wij raden hiervoor Visual Studio Code (VSC) aan.

Stap 1: Repository klonen

Download de repository van de website (GitHub link) naar je computer. Dit doe je door in VSC de terminal te openen via Terminal → New Terminal.

Voer vervolgens het volgende commando in:

git clone <url van de website>

Druk op enter. VSC zorgt er nu voor dat de website lokaal op jouw computer wordt gezet. Zorg ervoor dat je weet waar de map wordt opgeslagen.

Stap 2: Packages installeren

De website maakt gebruik van externe packages die je eerst moet installeren.

Voer in de terminal het volgende commando uit (zorg dat je in de projectmap zit):

npm install

of

npm i

VSC downloadt nu alle benodigde packages. Dit kan even duren. Er verschijnt ook een map genaamd node_modules. Dit is normaal en nodig om de website te laten werken.

Stap 3: .env bestand instellen

De website maakt gebruik van een .env bestand. Hierin staan gevoelige gegevens zoals wachtwoorden, API-instellingen en databasegegevens.

Dit bestand wordt niet meegeleverd in de repository in verband met de veiligheid.

Wil je dit bestand gebruiken? Vraag het dan aan bij de projectbeheerder.

Zodra je het bestand hebt ontvangen:

• Plaats het in de root van het project (naast package.json)
• Zorg dat het niet in een map staat, maar los in de hoofdmap

Zonder dit bestand zal de website niet werken.

Stap 4: MongoDB (database)

De website maakt gebruik van een MongoDB database. Hierin wordt data opgeslagen van reizen en gebruikers.

De verbinding met de database wordt automatisch gelegd via het .env bestand. In de meeste gevallen hoef je hier niets voor te doen.

Stap 5: Begrijpen van de projectstructuur

Voordat je de website draait, is het handig om te weten waar alles staat:

• views/
  Bevat EJS-bestanden (HTML-templates). Dit zijn de pagina’s van de website.
• sec/styles/
  Bevat alle CSS-bestanden voor de styling van de website.
• router/
  Bevat JavaScript-bestanden met de logica en routing van de website.

Stap 6: Website starten

Om de website lokaal te draaien, gebruik je het volgende commando in de terminal:

npm run dev

Dit zorgt ervoor dat de server wordt gestart en de website lokaal draait.

Meestal verschijnt er in de terminal een melding zoals:

Server running on http://localhost:3000

Stap 7: Website bekijken

Open je browser en ga naar:

http://localhost:3000

Als alles goed is gegaan, draait de website nu lokaal op jouw computer. Je kunt nu zelf aanpassingen maken en verder ontwikkelen.

Succes!