Getting the tools needed to run Sauder LS, Canvas API projects
💡 The basic setup for working with any Sauder LS Canvas API tools is:
- A tool for getting/updating projects
- An environment to run it in
GitHub is our tool for distributing projects and managing updates. We discuss GitHub in more detail in the next section (managing projects with GitHub). For now you'll need to:
- ✅ Create a free GitHub Account
- ✅ For LS-Ops: Contact someone on the Canvas API team to be added to the saud-learning-services/ls-ops team on GitHub (you'll need this to access certain projects)
- ✅ Download GitHub Desktop
💡 GitHub Desktop isn't necessary if you'd prefer to work in Terminal (but make sure you have Git installed)
For managing project environments, we use Anaconda. We recommend the Anaconda Navigator app for anyone not comfortable working in Terminal.
- ✅ Download Anaconda Navigator (recommended for most)
- select the 64-Bit Graphical Installer for your operating system. Note that some older Windows computer may need to install the 32-Bit Graphical Installer (you can check here)
Once you have done all the above, you're ready to start downloading and running projects.
We've provided a 👷 Setup Test Project on our GitHub that you can use throughout the remainder of the documentation to ensure you have everything up and running correctly. We'll provide you with a step-by-step on how to get this project running on your machine, and you can apply this same process to all tools.
Once everything is configured correctly, you should see an output of "Hey {your-name-on-canvas}":
💡 Every reference to the test project in the remainder of the docs will be labeled using the 👷 icon