Sakai App Builder

Owned by Former user (Deleted)
Last updated: Aug 21, 2014 by Former user (Deleted)
4 min read

PAGE IS OUT OF DATE!!!

see the following pages instead:

https://confluence.sakaiproject.org/display/BOOT/Sakai+Wicket+Maven+Archetype
https://confluence.sakaiproject.org/display/BOOT/Sakai+Spring+MVC+Maven+Archetype

 

 

Information

The Sakai AppBuilder is a RAD tool that allows you to quickly create Sakai webapp projects in Eclipse that will work in the Sakai Framework. Use these as a basis for the projects that you want to make without all the busy work of creating the structures and adding in all the dependencies. You can choose various UI layer options and implementation types to get you started quickly. This will not write your entire app for your, but it should help you get started quickly.
Former user (Deleted) (me) came up with the idea for this plugin and wrote the current versions so please contact me if you have questions or suggestions related to it.

Where do I get it?

The Sakai App Builder can be installed from within Eclipse using the built-in update feature as follows:

  1. Start Eclipse
  2. Under the "Window" menu, select "Preferences"
  3. Expand the "Java" heading on the left side
  4. Expand the "Build Path" subheading
  5. Single-click the "Classpath Variables" subheading
  6. Click the "New" button
  7. For the Name, enter "M2_REPO"
  8. Click the "Folder" button, then navigate to the location of your local maven 2 repository (you want the repository directory: ~/.m2/repository)
  9. Click "OK" to close the folder browsing dialog.
  10. Click "OK" to close the "New Variable Entry" dialog.
  11. Click "OK" to close the preferences window.
  12. Under the "Help" menu, select "Software Updates", then "Find and Install".
  13. Highlight the radio button marked "Search for new features to install", then click "Next".
  14. Click the button marked "New Remote Site".
  15. For the Name, enter "AppBuilder Site"
  16. For the URL, enter http://source.sakaiproject.org/appbuilder/update/
  17. Make sure the checkbox next to the new remote site is checked, then click "Finish"
  18. Check the box next to the latest version of Sakai AppBuilder, then click "Next"
  19. Read the license agreement, select the radio button indicating that you agree to the terms, then click "Finish"
  20. Select an alternate installation path if desired, then click "Finish" again
  21. Click "Install" on the next screen
  • Note: The plugin requires eclipse 3.2 or better

How do I use it? (plugin is installed, now what?)

Follow these steps to create a Sakai webapp starter project in eclipse:

  1. Click on File -> New -> Project -> SakaiProject -> Sakai App Project to start the wizard
  2. Enter a name for your project
  3. Change the directory location for the project if you don't like the default
    • Recommended: Use your local Sakai source root folder if you want your project ready to build, deploy, and run in Sakai (otherwise, you will have to move it and reimport it into Eclipse)
  4. Change the project key if you don't like the autogenerated one
  5. Select a UI display layer technology
  6. Select an implementation
    • Note: The directory structure only option will not produce a funcitonal app
  7. Click Finish to generate the webapp
    • Check the README file in the root of the new project for information on using the new project

Versions

  • 0.5 (Initial Release) - Sept 25, 2006
    • Build a functional tool to use as a basis for Sakai application development
      • Enter a project key and name which are used throughout the generated application
    • Choose from 3 display technologies (RSF, JSF, JSP)
    • Choose from 3 implementations
      1. Full CRUD app - a full 2 screen application which allows for creation, reading, updates, and deletes of items
      2. Hello World - a basic hello world app for those who want to start simple
      3. Directories Only - just the correct directory structure and maven project files for those who want to start with bare bones
  • 0.6 - Oct 12, 2006
    • Added support for Apache Velocity templates
      • Deprecated the old homegrown template system
    • Added an update site for the plugin
  • 0.7 - Nov 14, 2006
    • Corrected but that caused 0.6 to not update correctly
    • Added code to do better Sakai security (using Authz)
      • Add default security permissions demo code
    • Updated to use Generic DAO 0.8
    • Fixed a scope bug in the RSF templates
  • 0.77 - May 18, 2007
    • RSF updated to use 0.7.1 and new features for that version
    • Added ability to choose a package prefix (org.sakaiproject no longer required)
    • Fixed some template bugs
    • Added checking for reserved words in key and package name
    • Added extra comments
  • 0.82 - Aug 24, 2007
    • Added Maven 2 build options
    • Updated version of RSF, generic-dao, and other jars
    • Changed the created file structure to match with the new one at Sakai application (tool) structure
  • 0.9 - ??
    • Possibly add in velocity as a presentation option?
    • RSF OTP tool as an option?

Frequently Asked Questions (FAQ)

Where do I get the source?

Sakai contrib has the source for the plugin: https://source.sakaiproject.org/contrib/programmerscafe/appbuilder/
The source is licensed under the Creative Commons Attribution-ShareAlike 2.5 License.

Why didn't you include more display technologies or options?

Probably because I didn't think anyone wanted them. Send me a note if you have suggestions.

When I try to create a project in my sakai source directory (not using the default location) I get an error saying the project exists or I cannot create a project in that folder?

This is most likely caused because you are using Eclipse 3.1. Eclipse 3.2 is absolutely the lowest version you can use with this plugin safely.
If you are using 3.1 you can create the project and then move it to your Sakai source folder but that is dangerous. I recommend you upgrade to Eclipse 3.2.