roxolan / canvas-development-tools

Some handy scripts that I use to make life better while working on Canvas by Instructure

canvas-development-tools

Some handy scripts that I use to make life better while working on Canvas by Instructure.

Script breakdown:

1. CODES.sh: The Canvas Open Development Environment Script (CODES) will take any OS X, Arch Linux, Ubuntu, Fedora, or Linux Mint system from a base install to a fully setup environment for developing Canvas. This script will do everything that the other scripts do individually, generally in a more robust fashion since the current PATH, working directory, and state of the system are more predictable. This script is full of helpful prompts and output to help you figure out what's going on when things go wrong. It can also be run as many times as needed to complete a setup or to clone a new repo.
2. git-gerrit-submit: This handy script should be copied to somewhere in your PATH. After that, you can use the command git gerrit-submit to easily push the current changes to gerrit
3. setup-new-repo.sh: This script sets up a freshly cloned canvas repo by building assets, setting the gerrit hook, creating ctags, etc. This script requires the others since it simply calls them to do its job
4. backup-config-files.sh: This script will back up your current config files config/*.yml to a private git repo so you don't have to recreate them in the event that you lose them (such as a hard drive crash, a stolen computer, or a git clean -xfd). Each time you run this script a new commit is made to the repo with your latest changes. It will also push for you if you've set a remote (not required though, you can leave it as a local only repo if you want)
5. backup-databases.sh: This script does a sql dump of your development databases and stores them in a directory named after the date. Very handy.
6. add-custom-gems.sh: This script adds a few custom gems that I like to use, such as colorize, which makes outputting color to the Rails log easier
7. add-gerrit-hook.sh: If you work for Instructure, Gerrit is mandatory. This script adds a post-commit hook that automatically adds a gerrit change-id and does some other helpful checks
8. build-assets.sh: This script builds the canvas assets using rake
9. create-database-config.sh: This script creates a basic database configuration for you 8. generate-ctags.sh: This script generates a fresh set of ctags for use with your favorite text editor
10. initialize-databases.sh: This script runs the db initialization commands
11. set-ruby-version.sh: This script writes the current ruby version to a .ruby_version file for use with chruby auto