npm package: @meurrensjonathan/test-design-system
Description: Deze repository bevat een voorbeeld-structuur (met documentatie, scripts en setup) voor een statische website (gegenereerd met vue-cli).
Latest version: 0.1.6

# Boilerplate: Vue Single Page Application #

Deze repository bevat een voorbeeld-structuur (met documentatie, scripts en setup)
voor een statische website (gegenereerd met vue-cli).

### Hoe gebruik ik deze boilerplate voor een nieuw project? ###

1. Fork deze repository ([meer info](https://confluence.atlassian.com/bitbucket/forking-a-repository-221449527.html))
2. Genereer een SSH key voor de repository ([meer info](https://confluence.atlassian.com/bitbucket/use-ssh-keys-in-bitbucket-pipelines-847452940.html))
3. Pas de naam van de applicatie aan in package.json
4. Doe de gewenste aanpassingen in setup (zie [Vue CLI](https://cli.vuejs.org/config/#vue-config-js)) en code.
5. Zet een nieuwe applicatie op in Dokku. Zie hieronder ([Hoe deploy ik dit](#markdown-header-hoe-deploy-ik-dit))
   voor meer informatie.
6. Commit en push master branch naar Bitbucket. Als alles correct geconfigureerd is, start er een automatische deploy naar Dokku.

### Hoe is dit project gestructureerd? ###

Voor een toelichting van de projectstructuur, zie
[de documentatie van Vue CLI](https://cli.vuejs.org/guide/html-and-static-assets.html).

`static.json` bevat configuratie voor Dokku (o.a. routing). Voor meer details bekijk je best
[documentatie van de buildpack](https://github.com/heroku/heroku-buildpack-static#configuration).

Verder bevat deze boilerplate ook een `scripts` folder, daarin vind je een bash-script
dat deze boilerplate op onze Dokku-server opzet.
Hieronder ([Hoe deploy ik dit](#markdown-header-hoe-deploy-ik-dit)) vind je meer informatie.

Tot slot bevat de boilerplate ook een configuratiefile voor bitbucket pipelines.
Op die manier worden deploys automatisch gedaan wanneer de master branch gepusht wordt.
Ook daarrond vind je hieronder ([Hoe deploy ik dit](#markdown-header-hoe-deploy-ik-dit)) meer informatie.

### Hoe draai ik dit lokaal? ###

```
yarn install
yarn serve
```

Dit opent de applicatie op [http://localhost:8080](http://localhost:8080).

Als je de setup wil aanpassen of meer informatie wilt, bekijk dan
[de documentatie van Vue CLI](https://cli.vuejs.org/config/).

### Hoe deploy ik dit? ###

Voor meer algemene informatie over deployments en de setup kan je
[de documentatie van Vue CLI](https://cli.vuejs.org/guide/deployment.html) bekijken.

Specifiek binnen Nificent kunnen applicaties automatisch deployen naar Dokku.  
Daarvoor moet je het volgende doen:

1. Zorg ervoor dat je lokaal een SSH key hebt waarmee je als root-gebruiker kan verbinden met dokku.nificent.be  
   Als dit nog niet gebeurd is, moet je eerst [Adriaan](mailto:adriaan.baelus@nificent.be)
   of [Sabatino](mailto:sabatino.masala@nificent.be) pingen (anders kan de applicatie niet opgezet worden).
2. Voer het Dokku setup script uit met de nodige parameters:

```bash
# Geef dit dezelfde naam als de Bitbucket-repo (anders moet de pipelines-configuratie aangepast worden)
APPLICATION_NAME=mijn-applicatie
# Kopieer dit uit de settings van de Bitbucket repo.
# Zie https://confluence.atlassian.com/bitbucket/use-ssh-keys-in-bitbucket-pipelines-847452940.html
BITBUCKET_SSH_PUBKEY=...
# Geef dit je eigen e-mail, op die manier krijg je zelf warnings van Let's Encrypt
LETSENCRYPT_EMAIL=email-adres
./scripts/setup-dokku.sh "$APPLICATION_NAME" "$BITBUCKET_SSH_PUBKEY" "$LETSENCRYPT_EMAIL"
```

Van zodra het setup-script uitgevoerd is, kan je de master-branch pushen naar Bitbucket.
Dit zal dan een automatische deploy naar Dokku starten.

### Ik heb een vraag of probleem, bij wie kan ik terecht? ###

* De eerste opzet is gedaan door [Adriaan](mailto:adriaan.baelus@nificent.be).
* Om nieuwe applicaties toe te voegen in Dokku moet je root-toegang hebben.  
  Daarvoor kan je best even polsen bij [Adriaan](mailto:adriaan.baelus@nificent.be)
  of [Sabatino](mailto:sabatino.masala@nificent.be).
* Op Slack