Create a track from scratch
Control everything right from the start.
This guide explains how to create a track from scratch from Web UI and Instruqt CLI.

Before you begin

Did you check the Build tracks page? This page sets you off for creating tracks.

Create track

Pick the Web UI or the Instruqt CLI route depending on your preference:
🌐 Web UI
πŸ’» Instruqt CLI
  1. 1.
    Open your browser and go to play.instruqt.com. ↳ Instruqt shows your content.
  2. 2.
    Click Create track. ↳ Instruqt shows the Start creating content page.
  3. 3.
    Click Create from scratch. ↳ Instruqt shows the Track details page.
  4. 4.
    In the Title field, enter the track title. ↳ As you enter the title, Instruqt automatically generates a slug in the Track slug field.
  5. 5.
    Leave the Track slug field as created by Instruqt or enter the slug of your liking.
    If you have changed the automatically created track slug and then update the title again, Instruqt regenerates the track slug.
  6. 6.
    In the Teaser field, enter the short track description.
    Anywhere in this process, you can click Back to go back to earlier steps and make changes.
  7. 7.
    In the Editor tab of the Description field, enter the track description in Markdown.
    Click the Preview tab to render your entered Markdown.
  8. 8.
    Click Next. ↳ Instruqt shows the Sandbox page, which gives you the option to: β€’ Add a Docker container β€’ Add a virtual machine β€’ Skip this step
  9. 9.
    Choose one or more of the following options: β€” If you want to add a Docker container, click Add a Docker container:
    1. 1.
      In the Hostname field, enter a name for the host.
    2. 2.
      Select either the:
      Predefined image tab
      Container image tab
      1. 1.
        Click the predefined image of your liking.
      1. 1.
        In the field Container image URL, enter the URL.
      2. 2.
        In the Memory (MB) field, enter the amount of memory you need.
    3. 3.
      Click Add container.
    4. 4.
      Choose one of the following options: β€’ If you are ready, click Next. β€’ Or repeat these steps to add another Docker container. β€’ Or continue with adding a virtual machine.
    β€” If you want to add a virtual machine, click Add a virtual machine:
    1. 1.
      In the Hostname field, enter a name for the host.
    2. 2.
      Select either the:
      Predefined image tab
      Compute Engine image tab
      1. 1.
        Click the predefined image of your liking.
      1. 1.
        In the field Compute Engine image, enter the image name.
      2. 2.
        In the Machine type list, select the machine you want to use.
    3. 3.
      Click Add container.
    4. 4.
      Choose one of the following options: β€’ If you are ready, click Next. β€’ Or repeat these steps to add another virtual machine.
    β€” If you do not want to add a Docker container or a virtual machine, click Skip. ↳ Finally, after clicking Next or Skip, Instruqt shows the Challenge page.
  10. 10.
    In the Title field, enter the challenge title.
  11. 11.
    In the Teaser field, enter the short challenge description.
  12. 12.
    Click Next. ↳ Instruqt shows the Challenge - Introduction page.
  13. 13.
    In the Select a type list, select the note type.
  14. 14.
    In the Editor tab of the Description field, enter the challenge description in Markdown.
    Click the Preview tab to render your entered Markdown.
  15. 15.
    Click Next and Next again.
  16. 16.
    In the Editor tab of the Assignment field, enter the assignment text in Markdown.
    Click the Preview tab to render your entered Markdown.
  17. 17.
    In the Tab title field, enter the name of the tab.
  18. 18.
    In the Tab type list, select the tab of your liking.
  19. 19.
    In the Sandbox host list, select one of the added Docker containers or virtual machines. Or leave the selection empty.
  20. 20.
    Click Next. ↳ Instruqt shows the Launch your track page.
  21. 21.
    Click Finish. ↳ Instruqt builds the track and shows the Track overview page.
  1. 1.
    Type the following command to create a track:
    1
    instruqt track create
    Copied!
  2. 2.
    Enter the track title:
    1
    ==> Track title: TRACK_TITLE
    Copied!
  3. 3.
    Enter option 1 to select From scratch:
    1
    ==> Start with an empty track or use a template:
    2
    ​
    3
    [1] From scratch
    4
    For full flexibility, start with an empty track
    5
    [2] From a template
    6
    To get started quickly, start from one of our templates
    7
    ​
    8
    Please select your method: 1
    Copied!
    ↳ Instruqt CLI creates the track and shows this output:
    1
    ==> Creating track TEAM/TRACK_NAME
    2
    ==> Creating track files
    3
    Created track directory and configuration files:
    4
    TRACK_NAME
    5
    β”œβ”€β”€ config.yml
    6
    └── track.yml
    7
    OK
    Copied!
    ⇨ TEAM and TRACK_TITLE will contain your team and track title.
Well done! Now you can play your track to see if everything works as expected.
Copy link
Edit on GitHub