Running the Galaxy Training material website locally

Overview

question Questions
  • How to setup the infrastructure to build training webpages?
objectives Objectives
  • Installing packages needed for rendering the webpage
  • Running the GTN material website locally
  • Tracking changes to the content live in the webbrowser

time Time estimation: 15 minutes

Introduction

If you want to run the entire GTN material website locally or test your new training material you can do this!

Currently, the website is generated from the metadata and the tutorials using Jekyll, a simple static site builder. We can use Jekyll to run a server to check if the tutorial is correctly added and rendered.

Agenda

In this tutorial, you will learn how to run a local instance of the GTN website:

  1. Installation of the requirements
  2. Checking the website generation
  3. Stopping the server

Installation of the requirements

The first step is to install the needed tools inside a conda environment. A conda environment is a directory that contains a specific collection of packages. For example here to run the website, we need ruby, pandas, requests, etc. By creating a conda environment and installing the needed tools there, we do not affect your main installation.

This step has to be done once.

hands_on Hands-on: Install the requirements

  1. Open a Terminal
  2. (If not done yet) Clone the training material GitHub repository: git clone https://github.com/galaxyproject/training-material.git
  3. Navigate to the training-material/ folder with cd
  4. Set up the conda environment

    It will install some needed tools (ruby, nodejs, etc) in a protected environment, without interfering with the existing tools or versions.

    1. Install conda (if not already installed): make install-conda
    2. Create the galaxy_training_material conda environment: make create-env
  5. Install Jekyll and related modules into the conda environment: make install

tip Troubleshooting

If you encounter an error about libxml2 on Linux, please try to install libxml2-dev (executing sudo apt install libxml2-dev) if on Debian/Ubuntu or libxml2-devel (executing sudo yum install libxml2-devel) if on Fedora/RedHat/CentOS, and re-run make install .

Checking the website generation

Once Jekyll and its modules are installed in our conda environment, we can check the generation of the website locally:

hands_on Hands-on: Checking the website generation locally

  1. Run a local Jekyll server with make serve
  2. Visualize at http://localhost:4000/training-material/
  3. Edit one of the tutorials:
    • For example, open topics/introduction/tutorials/galaxy-intro-peaks2genes/tutorial.md in a text editor of your choice.
    • Make some changes to the Introduction paragraph, and save the file.
    • Refresh the tutorial page in your browser until you can see the changes you made.
      • this may take a little bit of time; in the terminal you can monitor when the regeneration is complete

With make serve, a local Jekyll server will run in background. It will check the changes and regenerate the website accordingly. You may need to reload the page to see the changes (and sometimes to wait 1-2 minutes).

Stopping the server

Once you are done, you can stop the server and cleaning your repository.

hands_on Hands-on: Stoping the server

  1. Stop the server with CTRL-C
  2. Clean the repository: make clean

Conclusion

keypoints Key points

  • Checking the generated website can be done locally

congratulations Congratulations on successfully completing this tutorial!

Developing GTN training material

This tutorial is part of a series to develop GTN training material, feel free to also look at:
  1. Overview of the Galaxy Training Material
  2. Contributing with GitHub via command-line
  3. Contributing with GitHub via its interface
  4. Creating a new tutorial
  5. Creating a new tutorial - Creating Interactive Galaxy Tours
  6. Creating a new tutorial - Defining the technical infrastructure
  7. Creating a new tutorial - Slides
  8. Creating a new tutorial - Writing content in Markdown
  9. Generating PDF artefacts of the website
  10. Including a new topic
  11. Running the Galaxy Training material website locally