On this page

Run the demo on your computer

How-to

The demo page is a made-up app with Snaglist and a settings panel. Run it on your own computer to try changes before you add Snaglist to your site. To try it without installing anything, open the online demo instead.

Before you begin

  • Git and Python 3. Most Linux and Mac computers have both. On Windows, install them from git-scm.com and python.org (each opens in a new tab).

Steps

  1. Copy the Snaglist repository to your computer:
git clone https://github.com/TheMightyTRex/snaglist.git
  1. Go into its folder:
cd snaglist
  1. Start a small web server on your own computer only:
python3 -m http.server 8777 --bind 127.0.0.1
  1. Open http://127.0.0.1:8777/ in your browser. You will find the made-up app, with Send feedback, and Settings beside it.
  2. Change any setting. Send feedback restarts with it, and Your code shows the code to copy.
  3. To stop the server, go back to the terminal and press Ctrl and C together.

Things to note

  • The demo loads the design system's styles from the internet. Without a connection it still works, in plain colours.
  • Reports from the demo go to the Snaglist repository with the demo label. Change the repository in 'Send to' to send them to your own.

Find out more

This page on GitHub, where the help is written.