Summary

Product	Validator Web Frontend
Description	Vue.js app website for the IATI Validator.
Website	https://validator.iatistandard.org/
Related	js-validator-api, validator-services
Documentation	https://developer.iatistandard.org/
Technical Issues	https://github.com/IATI/validator-web/issues
Support	https://iatistandard.org/en/guidance/get-support/

Vue Template

Getting Started

• From GitHub click "Use this template"

Package install

To install:

npm install

Running local dev server

To run a development server using (./envs/.env.development vars):

npm start

To run a development server using (./envs/.env.production vars):

npm run dev:production

Building for Deployment

To make a production build using (./envs/.env.development vars):

npm run build:development

To make a production build using (./envs/.env.production vars):

npm run build:production

To serve a production build locally for testing (you likely need to run this for testing because the dev server won't be fast enough for the page speed tests):

npm run serve

Testing

Open Cypress UI

npm run cy:open

Run Cypress Tests from Command Line

npm run cy:run

You can run an individual test specification with the following:

npx --no-install cypress run --config-file cypress.config.local.js --spec path/to/spec.js

Linting and Formatting

ESLint and Prettier are employed for linting and formatting. Implemented following this guide: https://vueschool.io/articles/vuejs-tutorials/eslint-and-prettier-with-vite-and-vue-js-3/

It's recommended you install the following VSCode Extensions:

• ESLint VSCode extension.
• Volar

Manual Lint w/ ESLint

npm run lint

Manual Format w/ Prettier

npm run format

Vue 3 + Vite

This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Recommended IDE Setup

• VSCode + Volar