Quick start for developers
For developers here is a quick tutorial on how to set OpenSyllabus project into Eclipse
Installation Guide
Eclipse Configuration
OpenSyllabus Code Structure
Let's have a look at the OpenSyllabus code structure.
To keep it simple, in our developpement we created two separate projects (we mean Eclipse/Maven projects) : One project for the client part where you will find al the GWT source code and one project for the backend part where stands the Sakai's tool code.
Thus, the developer can code and debug all in Java by working depending to his needs in the backend project or in the client project.
OpenSyllabus backend is organized as a classical Sakai's tool following a File Structure based on classic Sakai's tool directories, such as : API (interfaces), Impl (implementations) and Tool (webapp) directory. In the Tool directory, there are RPCServlets and RPCInterfaces for Remote Procedure Call exchanges in the src/Java folder. In addition, the Tool directory contains the Index.jsp and something new : the compiled GWT content (all the generated GWT stuff : pure JavaScript and HTML)in the src/webapp folder.
Code Structure |
||
---|---|---|
Frontend project |
Backend project |
|
GWT code |
Sakai's tool code |
|
client |
API dir |
|
public |
Impl dir |
|
shared |
Tool dir |
... |
- |
Java |
webap |
- |
RPCServlets & RPCInterfaces |
index.jsp + JS code & HTML |