Project Title

Project description [Click here to see the interface]({{link to the site here}}).

Table of Contents

• Link for the visualization
• Deployment
• Steps to integrate the vis in static page
• Pages on DFP where This Viz is Used
• Related Repos
• Global CSS Files and Repo
• Build With
• Installation
• Local Deployment
• Available Scripts
• Tooling Setup
• Contact

Link for the visualization

[{{link to the site here}}]({{link to the site here}})

Deployment

The Production site deployed using Azure Static Web App and work flow can be found [here]({{link to the site here}})

Steps to Integrating the Visualization in the Data Future Platform or Any Other Page

All the different view of the visualization and steps to interegrate/embed it

Apart from the mentioned div above the following script and link needs to be added to the head or in the embed code

<script defer src="<Link to the Visualization Mentioned Above>/static/js/main.js"></script>
<link rel="stylesheet" href="https://undp-data.github.io/stylesheets-for-viz/style/mainStyleSheet.css" />
<link rel="stylesheet" href="https://undp-data.github.io/stylesheets-for-viz/style/StyleForGraphingInterface.css" />
<link rel="stylesheet" href="https://undp-data.github.io/stylesheets-for-viz/style/StyleForGraph.css" />

Pages on DFP Where the Visualization is Used

All the pages on the DFP or other places like viva topics etc. where this visualization is embeded or used.

Related Repos

List of all the repo that are used in this project as dataset, meta data, css etc.

Global CSS for UI and Graphs

Git Repo: https://github.com/UNDP-Data/stylesheets-for-viz

Link for stylesheets

• https://undp-data.github.io/stylesheets-for-viz/style/mainStyleSheet.css
• https://undp-data.github.io/stylesheets-for-viz/style/StyleForGraphingInterface.css
• https://undp-data.github.io/stylesheets-for-viz/style/StyleForGraph.css

Build with

All the main library/frameworks used in the project

Installation

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

Local Development

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.

Available Scripts

• npm run dev: Executes vite and start the local server for local deployment.
• npm run build: Executes tsc && vite build and builds the app for production and deployment.

Tooling Setup

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.

Contact

name and email id of the author