Website for De Voorhoede
- Clone the repository.
- Run
npm ci
to install dependencies. - All needed environment variables are listed in the .env.example file. To automatically set them fill in a
.env
file following the same structure as the example file.
cp .env.example .env
- Run app in development mode (
npm run dev
), see scripts. - Changes on master and content publishing from the CMS trigger a new build and deploy to the live environment.
dist/ <- generated app
client/ <- generated client-side app
src/ <- source files
client/ <- Nuxt app
assets/ <- core files, not public
components/ <- Vue components
layouts/ <- base layout for pages
pages/ <- view per route
static/ <- public assets
.env <- local environment variables
dato.config.js <- data dump configuration
netlify.toml <- Netlify build & function config
nuxt.config.js <- Nuxt app config
This project requires Node.js (>= v10.8.0) and npm (comes with Node).
After installing dependencies using npm install
the following scripts are
available:
npm run ... |
Description |
---|---|
analyze |
Analyze the bundles created during build. |
build |
Builds client and server for production to dist/ . |
dev |
Serves client app on http://localhost:3278 ("lean" in T9) with hot reloading. |
start |
Serves production version of client app from (/dist/ ) on http://localhost:3278 . |
data |
Imports all data from Dato CMS. |
This project uses eslint-plugin-vuejs-accessibility to test Vue components for accessibility issues.
For accessibility checking in the browser Vue Axe is used. Results of the tests can be seen in the browser console. When navigating to a new page it is best to refresh the page, as Vue Axe doesn't always trigger a rerun on navigation.
All components are documented with a README.md file in their own folder. Other documentation can be found here