https://github.com/undp-data/dv-economic-stress-tracker
https://github.com/undp-data/dv-economic-stress-tracker
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/undp-data/dv-economic-stress-tracker
- Owner: UNDP-Data
- Created: 2023-05-12T13:04:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-21T19:18:32.000Z (about 3 years ago)
- Last Synced: 2025-01-16T04:43:36.837Z (over 1 year ago)
- Language: TypeScript
- Size: 530 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Project Title
#### Project description [Click here to see the interface]({{link to the site here}}).
## Table of Contents
* [Link for the visualization](#section-01)
* [Deployment](#deployment)
* [Steps to integrate the vis in static page](#section-02)
* [Pages on DFP where This Viz is Used](#section-03)
* [Related Repos](#section-04)
* [Global CSS Files and Repo](#section-05)
* [Build With](#section-06)
* [Installation](#section-07)
* [Local Deployment](#section-08)
* [Available Scripts](#section-09)
* [Tooling Setup](#section-10)
* [Contact](#section-11)
## 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
```
```
## 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](https://nodejs.org/en/download/).
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`](https://vitejs.dev/) 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/](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](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](https://code.visualstudio.com/) and then install this [eslint plugin](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and you should be good to go.