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.
- Code Structure
- Frontend project (GWT code)
- client
- public
- shared
- Backend project (Sakai's tool code)
- api dir
- impl dir
- tool dir
- Frontend project (GWT code)
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.
OpenSyllabus frontend is organized as the recommended GWT project structurehttp://code.google.com/webtoolkit/documentation/com.google.gwt.doc.DeveloperGuide.Fundamentals.html#ProjectStructure where we have replaced the server side code by a shared packages.
- Code Structure
- Frontend project (GWT code)
- client
- public
- shared
- Frontend project (GWT code)
Package |
Purpose |
---|---|
org/sakaiquebec/opensyllabus/ |
The project root package contains modules XML files (i.e OsylEditorEntryPoint.gwt.xml) |
org/sakaiquebec/opensyllabus/client/ |
Client-side source files and subpackages |
com/example/cal/shared/ |
Server-side code, including RPC data models definition |
com/example/cal/public/ |
Static resources that can be served publicly |
The project was initially created following the instruction of Creating an Application from Scratch (with Eclipse)
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 RPC Servlets and RPC Interfaces 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 (GWT code)
- client
- public
- shared
- client
- Backend project (Sakai's tool code)
- api dir
- impl dir
- tool dir
- java
- client
- rpc
- OsylEditorGwtService.java (RPC Servlet)
- OsylEditorGwtServiceAsync.java (RPC Async Interface)
- server
- OsylBackingBean.java
- OsylEditorGwtServiceImpl.java
- rpc
- client
- webap
- index.jsp
- org.sakaiquebec.opensyllabus.OsylEditorEntryPoint (all generated JS code + HTML + images)
- osylcoconfigs (configuration files) I18N properties files, skin: images & css, rules.xml)
- java
- Frontend project (GWT code)
Development Cycle
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.
Since the server is not available, in the client project you have to plan to write into your code mockups of server. For instance, you can simulate the server by using static fake data code.
We've found 3 possible use cases:
- Use case A - client update only
When the developer has made a client code update only. In this use case, you have to invoke the javascript compilation then move the compiled javascript to the backend code. Also if your backend code is already deployed in Tomcat, just replace the javascript code by the new one.
- Use case B - backend update only
You only have to invoke Sakai Application Compilation and deployment with maven.
- Use case C - full compilation
The full compilation process is necessary when for example you change the interfaces of the RemoteProcedureCall.
Note
To save time, use hosted mode as much as possible for client code developments, because,it is faster than a GWT compilation.