Voilà Gallery

This is a gallery of Voilà examples. Use this for inspiration on using Voilà and ipywidgets.

View the gallery at voila-gallery.org.

Going back to the gallery screen

You can go back to the gallery landing page using the back button of the web browser.

Contributing new examples

1. Create a repository with your notebook. You can start from the hello-world example.
2. The gallery launches the examples using repo2docker, exactly the same way Binder does. This means that the repository can be first tested on Binder.
3. Test your repository on Binder.
4. Create a PR to voila-gallery that modifies tljh-voila-gallery/tljh_voila_gallery/gallery.yaml. You will need to fill in the following fields:
   • title: the title used in the page thumbnail.
   • description: the description used in the page thumbnail.
   • url: the URL of the notebook to render.
   • repo_url: the URL of the repository serving as source.
   • ref: the commit hash used to pin to a specific version of the example
   • image_url: the URL of the picture to use as thumbnail.

Deploying your own gallery

The Voilà gallery is built as a plugin for The Littlest JupyterHub (TLJH). To deploy your own instance:

1. Fork the gallery repo: https://github.com/voila-dashboards/gallery
2. Edit the tljh-voila-gallery/tljh_voila_gallery/gallery.yaml file with your own set of examples
3. Follow one of the tutorials to install TLJH
4. At the step asking for user data, use the following command:

#!/bin/bash
curl https://raw.githubusercontent.com/jupyterhub/the-littlest-jupyterhub/master/bootstrap/bootstrap.py \
 | sudo python3 - \
   --plugin git+https://github.com/<your-username>/gallery@master#"egg=tljh-voila-gallery&subdirectory=tljh-voila-gallery"

5. The install process might take between 5 and 10 minutes to complete.
6. Dependending on the method and cloud provider chosen in Step 1, you will get the public IP of the server, which can be used to access the gallery

Development

See CONTRIBUTING.md to know how to contribute and set up a development environment.

Related projects

License

We use a shared copyright model that enables all contributors to maintain the copyright on their contributions.

This software is licensed under the BSD-3-Clause license. See the LICENSE file for details.