https://github.com/palewire/first-visual-story

A step-by-step guide to publishing a standalone story from a dataset.
https://github.com/palewire/first-visual-story

data-journalism education journalism media news nodejs static-site-generator tutorial walkthrough

Last synced: about 2 months ago
JSON representation

A step-by-step guide to publishing a standalone story from a dataset.

• Host: GitHub
• URL: https://github.com/palewire/first-visual-story
• Owner: palewire
• License: mit
• Created: 2018-01-19T23:48:21.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-07-06T01:33:14.000Z (7 months ago)
• Last Synced: 2024-10-18T09:33:14.706Z (4 months ago)
• Topics: data-journalism, education, journalism, media, news, nodejs, static-site-generator, tutorial, walkthrough
• Language: CSS
• Homepage: https://palewi.re/docs/first-visual-story/
• Size: 57.3 MB
• Stars: 29
• Watchers: 16
• Forks: 9
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
A step-by-step guide to publishing a standalone story from a dataset.

- Tutorial: [palewi.re/docs/first-visual-story](https://palewi.re/docs/first-visual-story/)

- Demonstration: [palewire.github.io/first-visual-story](https://palewire.github.io/first-visual-story/)

- Issues: [https://github.com/palewire/first-visual-story/issues](https://github.com/palewire/first-visual-story/issues)

### Contributing to the tutorial

The documentation for this site is published via [Sphinx](https://www.sphinx-doc.org/en/master/) and written in [Markdown](https://www.markdownguide.org/) files in the [`tutorial` directory](/tutorial/).

An edit there followed by push to the master branch on GitHub will trigger the docs being redeployed to [https://palewi.re/docs/first-visual-story/](https://palewi.re/docs/first-visual-story/).

### Running the tutorial locally

- If you're using [pipenv](https://pipenv.pypa.io/en/latest/) (recommended), start a virtual environment with `pipenv shell`

- Install dependencies with `pipenv install --dev`

- Run `make docs`. You'll be able to see your local version of the docs at localhost:8000

### Editing the demostration site

The demonstration site at [palewire.github.io/first-visual-story](https://palewire.github.io/first-visual-story/) is published via GitHub Pages and the `demo` folder, following the instructions in the tutorial. Changes made there will go live following a push to the `main` branch.