Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shotstack/coronavirus-data-video-demo
A demo to show how data can be used to generate videos using the Shotstack API
https://github.com/shotstack/coronavirus-data-video-demo
coronavirus coronavirus-video generative-design video video-edit-sdk video-editing
Last synced: about 2 months ago
JSON representation
A demo to show how data can be used to generate videos using the Shotstack API
- Host: GitHub
- URL: https://github.com/shotstack/coronavirus-data-video-demo
- Owner: shotstack
- License: mit
- Created: 2020-03-28T11:48:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T01:46:25.000Z (over 1 year ago)
- Last Synced: 2024-06-14T06:33:26.444Z (3 months ago)
- Topics: coronavirus, coronavirus-video, generative-design, video, video-edit-sdk, video-editing
- Language: JavaScript
- Homepage: https://bit.ly/3bAJkZe
- Size: 74.2 KB
- Stars: 6
- Watchers: 3
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Coronavirus (COVID-19) Data Generated Videos
This is a demo to showcase using a data source to generate videos using the [Shotstack API](https://shotstack.io/docs/api/index.html).
[](https://youtu.be/TOQAbfCNV_o)
A NodeJS script loops through a data set of Coronavirus (Covid-19) global pandemic cases and deaths
sourced from [Our World In Data](https://ourworldindata.org/coronavirus-source-data) and generates a
video for a selected country.
---
## Requirements
This project was developed using Node v10.15.3 and NPM 6.4.1.
### API Key
To run the project you will need a Shotstack API key. If you do not have a key you can sign up via
the [Shotstack website](https://shotstack.io/).
Once you have a key, copy the `.env.dist` file and name it `.env`. Then add your staging API key next to
the `SHOTSTACK_KEY=` parameter.
Your `.env` file should look something like:
```
SHOTSTACK_ENDPOINT=https://api.shotstack.io/stage
SHOTSTACK_KEY=KnYTD1jak82B83hwvL8kT5jlT66MMVqI2zE4dPPs
```
---
## Installation
Install dependencies using the following:
```
npm install
```
---
## Usage
### Fetch/Update Data
Fetch the latest Coronavirus dataset:
```
npm run dataset
```
A CSV file `full_data.csv` is downloaded and saved in the project root directory.
### List Countries
Display the list of countries available in the CSV file:
```
npm run list
```
### Generate Video
Run the following command with the country you wish to generate a video for:
```
npm run generate -- --country [Country]
```
Replace [Country] with the country you want to generate a video for, i.e.
```
npm run generate -- --country 'Australia'
```
Note: the country value is case sensitive and must be entered exactly as it is stored in
the `Location` column in the CSV file. Use the `npm run list` command to see a list of
countries.
The edit request will be sent to the Shotstack API to be queued for rendering. After approximately
20 seconds the video will be ready and the URL will be output to the terminal.