3akai-ux - Sakai 3 UX/UI development

Essential Information

The main forms of communication for the project are the UX and the UI Development email list. The UX list discusses design related topics:
sakai-ux@collab.sakaiproject.org
The UI Development list discusses technical topics around front-end development:
sakai-ui-dev@collab.sakaiproject.org

We track bugs, issues and tasks in JIRA:
http://jira.sakaiproject.org/browse/SAKIII

A collection of resources and documents can be found on our Confluence page:
http://confluence.sakaiproject.org/display/3AK/Sakai+3+Home

Most time Sakai 3 UX/UI developers can be found on IRC:
server: irc.freenode.net
room: #sakai

General information about Sakai:
http://sakaiproject.org

If you would like to contribute to this project, feel free to fork this git repository, push your changes and send a pull request.

Quickstart

To get a Sakai 3 development instance up and running on your cmputer quickly follow these steps:

First make sure you have all the following installed on your machine:
Git version control system
Java JDK 1.5 or newer
Maven build system

Then you can set up an instance with the following Terminal commands on a Unix/Mac:

Create a "sakai3" folder in your home folder:
mkdir ~/sakai3 cd ~/sakai3
Check out the latest Nakamura code. This will create an "open-experiments" folder
git clone git://github.com/ieb/open-experiments.git cd open-experiments/slingtests/osgikernel
Check which stable tags are available:
git tag
Check out and switch to the latest stable tag (0.4 in this case):
git co -b 0.4 This is not required, you can also stay at bleeding edge by omitting this step.
Open up the "slingtests/osgikernel" folder and build the kernel:
cd slingtests/osgikernel mvn clean install
Start the kernel:
tools/clean_restart.sh
Open a browser and type "http://localhost:8080/dev" into the address bar

Done. Now you have a the latest stable kernel with latest stable UX code (from Maven repo) running on your local machine.

If you would like to do UI/UX development you will need to additionally to the following:

1 Switch to the previously created "sakai3" folder in your home folder
cd ~/sakai3

Check out the UX code from Github, this will create a "3akai-ux" folder:
git clone git@github.com:sakaiproject/3akai-ux.git
Go to the kernel's Felix console by typing the following address into the browser's address bar (preferably with an alternative browser from the one you are using from development):
"http://localhost:8080/system/console"
Log in using "admin" for username and password
Select the "Configuration" tab on the top part of the console
Open up the "Apache Sling Filesystem Resource Provider" module`s window (towards bottom of page)
Enter "/dev" in Provider Root field, enter the path to the "dev" folder in you checked out UX code to "Filesystem Root" field , and click "Save"
Open up the "Apache Sling Filesystem Resource Provider" again
Enter "/devwidgets" in Provider Root field, enter the path to the "devwidgets" folder in you checked out UX code to "Filesystem Root" field , and click "Save"

Done. Now if you go to "http://localhost:8080/dev" the kernel should load the files from your local machine, from the paths you`ve specified earlier.
You should be able to start modifying files and see changes in browser.