This project uses npm. For installation you will need to install node and npm, if you don't already have it. node and npm can be installed from here.
To install the project, simply clone the the repo and them run npm install in the project folder. You can use terminal on Mac and Command Prompt on Windows.
This project is bootstrapped with Vite and was created using npm create vite@latest command.
Run the terminal or command prompt and then run the following
git clone https://github.com/UNDP-Data/{{projectName}}.git
cd {{projectName}}
npm install
To start the project locally, you can run npm run dev in the project folder in terminal or command prompt.
This is run the app in development mode. Open http://localhost:5173/ to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
npm run dev: Executesviteand start the local server for local deployment.npm run build: Executestsc && vite buildand builds the app for production and deployment.
This project uses ESLint integrated with prettier, which verifies and formats your code so you don't have to do it manually. You should have your editor set up to display lint errors and automatically fix those which it is possible to fix. See http://eslint.org/docs/user-guide/integrations.
This project is build in Visual Studio Code, therefore the project is already set up to work with. Install it from here and then install this eslint plugin and you should be good to go.