Setup

Setting up the Schedules Development Environment

Setting up the development environment for Schedules is intended to be a very simple process that does not require a large amount of complicated steps. Look below for instructions specific to your operating system.

Debian Based Linux (including Ubuntu)

Installing the Prerequisite Software

Debian Based Linux (including Ubuntu)

The only prerequisite that needs to be installed first is Git, which you can install with the following command (you may skip this step if you already have git on your computer):

sudo apt-get update

sudo apt-get install git

You should be able to install the system now.

Arch Based Linux

This section still needs to be documented.

Fedora Linux

This section still needs to be documented.

macOS (Apple, formerly OS X)

The prerequisites that need to be installed first are Git and Homebrew, which you can install with the following commands (you may skip this step if you already have git and Homebrew on your computer):

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" installs Homebrew

brew install git

You should be able to install the system now.

Note: Homebrew is used in this setup and the configuration scripts to simplify things. If you think you know better and want to use a different package manager, go ahead.

Windows

If you are running Windows 10 version 1608 (Aniversary Update) or later on a 64 bit machine, you can use the Windows Subsystem for Linux. You can follow the Ubuntu instructions above using 'Bash on Ubuntu on Windows'.

Otherwise, this section still needs to be documented

Installing Schedules

Installing schedules is as simple as cloning down the repository and running the configuration script. First, you should create your development folder. For example:

mkdir ~/dev

mkdir ~/dev/srct

cd ~/dev/srct

Once you have your development folder set, clone the repository with either SSH or HTTPS:

SSH (Recommended)
- git clone git@git.gmu.edu:srct/schedules.git
HTTPS
- git clone https://git.gmu.edu/srct/schedules.git

And last, run the configuration script which will install any needed dependencies and start the development server:

cd schedules

sudo ./configure.sh

Run the Development Server

To start the server, run the start.sh script located in the root of the repository.

./start.sh