fluid-article

Template repo for Fluid article. To create a new online article:

• Create a new repository from this template
• In the Workflow Permissions settings for the new repo, enable the following for GitHub Actions:
  • Read and write permissions
  • Create and approve pull requests
• Once the test-deploy workflow has succeeded, go to the Pages settings for the repo and configure GitHub Pages to deploy from the gh-pages branch
• When pages-build-deployment completes your website should be live

Running website locally

Software required

• git
• Node.js >=18.0.0
• yarn >= 1.22

Windows users may also require

• Ubuntu WSL

Installation

1. Run yarn install

2. Run yarn install-article to copy the example site from @exploreable-viz/fluid

Bundling website

To bundle a website:

1. Run yarn bundle-website $WEBSITE_NAME

This will create a folder in dist called $WEBSITE_NAME.

Serving website Locally

To run the website in the browser:

1. run npx http-serve dist/$WEBSITE_NAME -a 127.0.0.1 -c-1
2. Open browser at localhost

Running Puppeteer tests

To run your website tests:

1. Run yarn website-test $WEBSITE_NAME

Convenience commands for single website

If you have a single website called article, the following are synonyms for the above:

• yarn bundle
• yarn serve
• yarn test