...
This document is intended to help deployers setup a development environment for modifying the Scheduling Assistant. This is not technically required if you don't plan to make any changes; see the overlay documentation on how to quickly deploy an instance of the application with minimal changes.
| Info |
|---|
The source code for the Scheduling Assistant has moved to github. The video currently listed in this document shows how to checkout the code from subversion; the code is no longer there. A new video will be available soon that shows how the source can be checked out from github. |
Setup
The Scheduling Assistant is a multi-module Maven Java project. It's deliverables include a Web Application that is deployed in Apache Tomcat and a JSR-168 Portlet.
Before you begin, you will first need to create an account on Github. Once you've got an account, follow their instructions to Set up git. After your workstation is setup, learn how to fork a repository.
Create your fork from https://github.com/Jasig/sched-assist.
Now that you've got a fork, you'll need to use the address to your fork when "Cloning the repository" in Eclipse. The address will be viewable at something like https://github.com/your-username-here/sched-assist.
4 minute video demonstrating how to check out the source in Eclipse to get started developing:
https://mywebspace.wisc.edu/npblair/jasig/jasig-sched-assist-developergit-start.ogvsetup.ogv
Contribute
If you have new features you'd like to contribute back to the project, our move to git has made it very easy:
- Make sure your work is done on a branch - not on master!
- Follow the steps in the uPortal Git Workflow document: Git Workflow for Non-Committers
- Send a Pull request when done!
Quick start with Bedework
...