Code Monkey home page Code Monkey logo

3akai-ux's Introduction

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:
[email protected]
The UI Development list discusses technical topics around front-end development:
[email protected]

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:

  1. Create a "sakai3" folder in your home folder:
    mkdir ~/sakai3 cd ~/sakai3

  2. 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

  3. Check which stable tags are available:
    git tag

  4. 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.

  5. Open up the "slingtests/osgikernel" folder and build the kernel:
    cd slingtests/osgikernel mvn clean install

  6. Start the kernel:
    tools/clean_restart.sh

  7. 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

  1. Check out the UX code from Github, this will create a "3akai-ux" folder:
    git clone [email protected]:sakaiproject/3akai-ux.git

  2. 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"

  3. Log in using "admin" for username and password

  4. Select the "Configuration" tab on the top part of the console

  5. Open up the "Apache Sling Filesystem Resource Provider" module`s window (towards bottom of page)

  6. 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"

  7. Open up the "Apache Sling Filesystem Resource Provider" again

  8. 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.

Development Guidelines

You can find our guidelines and more information about the project on our Confluence page:
http://confluence.sakaiproject.org/display/3AK/Sakai+3+UX+Development+Guidelines+and+Information.

Getting started guide:
http://confluence.sakaiproject.org/display/3AK/Sakai+3+UX+Prototype+development

Demo Servers

Stable demo server:
http://3akai.sakaiproject.org/dev/

Unstable nightly server:
http://sakai3-nightly.uits.indiana.edu:8080/dev/index.html

Prototype server:
http://sakai3sam.caret.cam.ac.uk/dev/index.html

Nakamura: Sakai 3 kernel

Nakamura is the kernel project for Sakai 3

The Nakamura source code can be found in Github:
http://github.com/ieb/open-experiments

Discussion and information on various kernel topics can be found in the following Google group:
http://groups.google.com/group/sakai-kernel

Documentation for Nakamura can be found here:
http://confluence.sakaiproject.org/display/KERNDOC/Nakamura+Documentation

They track bugs and issues in JIRA here:
http://jira.sakaiproject.org/browse/KERN

3akai-ux's People

Contributors

bethkirschner avatar botimer avatar christianvuerings avatar croby avatar jsloane avatar lancespeelmon avatar maximedebosschere avatar rieteke avatar simong avatar stuartf avatar wudigit avatar zathomas avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.