README.md

IATI Datastore Search Web Application

Summary

Product	Datastore Services API
Description	Single-page Vue app that is the frontend for the IATI Datastore.
Website	https://datastore.iatistandard.org
Related	IATI Datastore Services, IATI Validator
Documentation	https://developer.iatistandard.org/
Technical Issues	https://github.com/IATI/datastore-search/issues
Support	https://iatistandard.org/en/guidance/get-support/

Prerequisites

• Node.js: get version from .nvmrc or if using nvm run nvm use

Install dependencies

npm install

Running local dev server

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

npm start

You will want to navigate to http://localhost:3000/ to test as the CORS rules for Dev only allow http://localhost:3000/ not http://127.0.0.1:3000/

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 (NOTE: running the above servers will may not be suitable for running the tests against because they are significantly slower and the tests include some timed tests):

npm run serve

Testing w/ Cypress

Open Cypress UI

npm run cy:open

Run Cypress Tests against local environment from Command Line

npm run cy:run-ci

Run Cypress Tests against deployed development environment from Command Line

npm run cy:run

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