Browse Source

Updated readme

master
Elwin Buisman 2 months ago
parent
commit
0ec7c9deb5
  1. 25
      README.md

25
README.md

@ -31,6 +31,10 @@ yarn build
yarn start
```
### Building, Yarn en security:
Je kunt een multi-stage dockerfile gebruiken voor de build stap, in dit voorbeeld staat ook hoe je de yarn lockfile kunt gebruiken zodat je 100% van de dependencies in de hele tree vastlegt tussen dev en prod, en niet afhankelijk bent van updates van packages (al dan niet met juiste versie nummers)
[https://nuxtjs.org/deployments/koyeb#dockerize-your-application](https://nuxtjs.org/deployments/koyeb#dockerize-your-application)
## Testing
```bash
@ -77,3 +81,24 @@ yarn feature:merge
# it verifies the existence of the commit
yarn deploy "commit"
```
## Framework and components
**Nuxt**: Web-framework around vue.js which also handles the server-side part [Nuxt: get started](https://nuxtjs.org/docs/get-started/installation)
**Vue**: Rendering library: [https://vuejs.org/v2/guide/](https://nuxtjs.org/docs/get-started/installation)
**Vuex**: Vue state management library: [https://vuex.vuejs.org/](https://vuex.vuejs.org/) Visual explanation about Vuex: [https://vuex.vuejs.org/#what-is-a-state-management-pattern](https://vuex.vuejs.org/#what-is-a-state-management-pattern)
**Axios**: Nuxt server and client request library: [https://axios.nuxtjs.org/](https://axios.nuxtjs.org/)
**i18n**: Nuxt internationalisation library: [https://i18n.nuxtjs.org/](https://i18n.nuxtjs.org/)
**ajv-i18n**: Multi-language json-schema validator: [https://github.com/ajv-validator/ajv-i18n](https://github.com/ajv-validator/ajv-i18n)
**Vuetify**: Commonly used UI library based on Google's Material Design: [https://vuetifyjs.com/en/](https://vuetifyjs.com/en/)
## Authentication
In store/index.js wordt de nuxtServerInit gestart bij het renderen op de server, hier wordt de /me profile url aangeroepen, als deze succesvol afrond wordt de store bijgewerkt met de user's profile en de isAuthenticated op true gezet. Verderop in de middleware, deze wordt uitgevoerd als de route gevonden is, wordt van de gevonden pagina opgehaald wat de "auth" settings zijn. Als voor de pagina authenticatie vereist is wordt de user ge-redirect.
Het laatste stuk staat in de interceptor van plugins/axios.js, de response interceptor kijkt naar de status code van het http request en als die 401 is wordt de user ge-redirect naar de authenticatie pagina.
Loading…
Cancel
Save