Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Skalli/Contributor Guide"
m |
m (→Run Skalli from IDE) |
||
Line 70: | Line 70: | ||
The Jetty working directory is expected to be in <code>${workspace_loc:org.eclipse.skalli.target}/workdir</code>. This directory has to be created first within your workspace, and will contain all persistent data of Skalli (in folder storage). | The Jetty working directory is expected to be in <code>${workspace_loc:org.eclipse.skalli.target}/workdir</code>. This directory has to be created first within your workspace, and will contain all persistent data of Skalli (in folder storage). | ||
+ | |||
+ | Jetty will run by default on port 8080. So start a browser to URL [http://localhost:8080], and you should see a login dialog to authenticate. The default user configured is "admin", password "admin". Then you are able to create projects, edit projects, search projects etc. The created projects are located in <code>org.eclipse.skalli.target/workdir/Storage/Projects/*.xml</code>. | ||
+ | |||
+ | TODO: icons are missing, get them into themes. | ||
= Build = | = Build = |
Revision as of 12:30, 26 April 2011
Contents
Development IDE Configuration
Skalli has Java 5.0 as a minimum requirement. It is recommended to use latest Eclipse release, classic edition is sufficient for development. As Skalli source code is hosted in git, it is recommended to use EGit plugin too.
Note: As of 2011-04-26, Indigo release 3.7M6a is working well. Install EGit 0.11.3 from included software site at "Indigo - http://download.eclipse.org/releases/indigo".
Obtaining Sources
Skalli is hosted in Git. You can browse the repository in gitweb.
You can get the source code via git commandline tool
git clone git://git.eclipse.org/gitroot/skalli/org.eclipse.skalli.git
or cloning a repository using EGit from URI git://git.eclipse.org/gitroot/skalli/org.eclipse.skalli.git
.
Clone from master
branch and specify remote branch as origin/master
.
Now import all projects into your workspace. Import -> Git -> Projects from Git ->
Select your cloned repo -> Import existing projects -> Select all projects -> Finish
. You will import 29 projects (as of 2011-04-26).
Note: there will be compile errors, as some patches are needed for successful compilation.
Required patches (as of 2011-04-26)
Skalli requires some patches due to ongoing IPzilla process to compile and run Skalli.
1. Add missing 3rdparty libraries to target platform
These 3rdParty libraries are missing.
org.restlet version="2.0.0.RC4" org.restlet.ext.servlet version="2.0.0.RC4 org.restlet.ext.xstream version="2.0.0.RC4 org.codehaus.jettison.jettison version="1.2.0" org.apache.lucene.lucene-core version="0.1.7" org.apache.lucene.lucene-core version="0.1.7" org.apache.lucene.lucene-highlighter version="0.1.7" org.apache.lucene.lucene-queries version="0.1.7" com.thoughtworks.xstream version="1.3.1" org.custommonkey.xmlunit version="1.2.0" org.xmlpull version="1.1.4.c" com.vaadin version="6.4.0"
They can be downloaded from these locations: [TODO]
2. Add these 3rdParty bundles to Skalli target platform
Open org.eclipse.skall.target/skall-tycho.target
file, add a directory with all of these bundles downloaded from these projects.
For simplicity, you can use the complete target platform definition from this patch [TODO]. It is expecting these bundles in folder org.eclipse.skalli.target/target-platform-3rdparty/plugins
3. Set this target definition as your target platform
Click right upper link "Set as Target Platform". This will rebuild all projects in workspace.
4. Add a missing class from VAADIN com.vaadin.ui.CustomField
This class is not yet part of the VAADIN core. but can be downloaded from [1]. Please use Version 0.8.2, as package has been refactored from version 0.9.0 on. Note: You have to register yourself at VAADIN to download the file.
Copy this file into the project org.eclipse.skalli.view/src/main/com/vaadin/ui/CustomField.java
. Now all projects should compile sucessfully.
Run Skalli from IDE
Skalli provides a launch configuration at org.eclipse.skalli.target/skalli.launch
. This launch configuration is using OSGi / Jetty provided WebContainer (RFC66) implementation. Required Jetty configuration files are provided within jetty folder (etc/jetty.xml
). The log files will be stored in jetty/logs
.
The Jetty working directory is expected to be in ${workspace_loc:org.eclipse.skalli.target}/workdir
. This directory has to be created first within your workspace, and will contain all persistent data of Skalli (in folder storage).
Jetty will run by default on port 8080. So start a browser to URL [2], and you should see a login dialog to authenticate. The default user configured is "admin", password "admin". Then you are able to create projects, edit projects, search projects etc. The created projects are located in org.eclipse.skalli.target/workdir/Storage/Projects/*.xml
.
TODO: icons are missing, get them into themes.
Build
Skalli builds run on build.eclipse.org via Hudson using
Hudson
Website
The Skalli website is located in a CVS repository on the Eclipse Foundation's servers.
- File > Import > CVS > Projects from CVS
- Select URL :pserver:anonymous@dev.eclipse.org/cvsroot/org.eclipse
- Use module skalli (from www)
- Finish