source: ComponentRegistry/branches/ComponentRegistry-1.14/README @ 5861

Last change on this file since 5861 was 5861, checked in by Twan Goosen, 10 years ago

renamed 1.14.0 branch to 1.14

  • Property svn:mergeinfo set to (toggle deleted branches)
    /ComponentRegistry/trunk/READMEmergedeligible
    /ComponentRegistry/branches/ComponentRegistry-1.12.0/README2071-2124
    /ComponentRegistry/branches/ComponentRegistry-1.13.0-olha/README2143-2514
    /ComponentRegistry/branches/ComponentRegistry-1.14.0/README3885-4093
    /ComponentRegistry/branches/ComponentRegistry-schematron/README1751-1774
    /ComponentRegistry/branches/georgovassilis_workspace/README3663-4097
    /ComponentRegistry/branches/jeaferversion/README1631-1680
    /ComponentRegistry/tags/ComponentRegistry-1.9.1/README1565
File size: 5.7 KB
Line 
1CLARIN COMPONENT REGISTRY
2=========================
3
4What is it?
5-----------
6The Component Registry stores CMDI metadata components and profiles and
7offers a service to list and retrieve them. The BrowserGui is a web
8application displaying available components in the component registry in the
9correct context: application domain, creator, creation date, version, etc.
10The registry offers a hierarchical structure for browsing the components.
11
12The componentRegistry is set up as a Flex Gui frontend communicating with a
13Java based backend (REST service).
14
15The ComponentRegistry is a central software component to the Clarin MetaData
16Infrastructure (CMDI). For more information on CMDI, see
17<http://www.clarin.eu/cmdi>.
18
19Documentation
20-------------
21- A set of TRAC pages for developers has been setup on the Clarin.eu TRAC at
22<http://trac.clarin.eu/wiki/ComponentRegistryAndEditor>. You will need a
23login to access these pages. To request one, contact <clarin@clarin.eu>.
24
25- The REST interface is documented at <http://www.clarin.eu/node/3248>.
26
27- Documentation for users is available at <http://www.clarin.eu/node/3223>.
28
29- Information on internally managing the application can be found at
30<https://trac.clarin.eu/wiki/ComponentRegistryAndEditor#Management>.
31
32Project structure
33-----
34This project contains two modules:
35
36- 'ComponentRegistry', a Java project that implements the Component Registry
37  REST service, administration pages and a web container for a client UI.
38- 'ComponentBrowserGui', a Flex project that implements a client for the
39  Component Registry REST service.
40
41How to set up for development/building from source
42--------------------------------------------------
43* Creating initial setup files:
44
45 - in ComponentBrowserGui: `mvn buildnumber:create flexmojos:flexbuilder`
46        - This generates project files for Flash Builder. Open in FB using
47          File > Import Flex Project and use the 'Project Folder' option.
48 - in ComponentRegistry: `mvn eclipse:eclipse` 
49        - Generates eclipse configuration
50        - For NetBeans, simply open the POM as a project
51
52When using FlashBuilder to develop the ComponentBrowserGui, create a porject by
53"Import a Flex project from an FXP, ZIP, or project folder".
54
55When using FlashBuilder to develop, make sure to configure the correct Flex SDK. It should
56be version 3.6, which you can download for free at <http://www.adobe.com/cfusion/entitlement/index.cfm?e=flex3sdk>.
57In addition, you should configure the project to build for Flash player 10.0.0 (instead of default minimum version
58provided by SDK).
59
60* Creating war artifact for local deployment:
61
62 - in ComponentBrowserGui: mvn install
63 - in ComponentRegistry: mvn package
64 
65The ComponentRegistry war will include the flex swf file needed to start the application.
66So deploying the resulting war will be enough to start the application.
67
68* Building for specific deployment environment
69By default the application is set to work when deployed on localhost. If you want to change that
70change the serverRootUrl property in the pom.xml of ComponentRegistry. There are already build
71profiles for lux16.mpi.nl and catalog.clarin.eu that set these correctly. You can trigger
72these by providing the -Plux16 or -Pclarin options to mvn respectively.
73
74The rest service relies on a Component Registry database, for which a create script can be found in
75the src/sql directory. For configuration instructions, see the comments in context.xml.
76
77* NOTE on generating java classes from general-component-schema.xsd.
78The ComponentRegistry needs the general-component-schema.xsd, which should be found at:
791) ComponentRegistry/src/main/binding/ -> that directory has a svn:externals property pointing to the schema.
80Do a 'svn propget svn:externals' to see the property. Results in: 'http://svn.clarin.eu/metadata/trunk/toolkit/general-component-schema.xsd general-component-schema.xsd'
81
82* Missing some artifacts for Maven?:
83The ComponentBrowserGui project needs some swf files which are not in any maven repository I could find.
84So install them manually: go to ComponentBrowserGui/libs/ and run the commands in maveninstalllib.txt
85
86* Developing and Debugging "ComponentRegistry" back-end.
87 
88Select the 'development' Maven profile (Netbeans has a dropdown menu for this) to get
89logging output on the console.
90
91If, when trying to run the backend, you're getting errors from Spring stating that
92  "Name [ComponentRegistry] is not bound in this Context. Unable to find [ComponentRegistry]"
93it means that you do not have a JNDI resource for the database connection set up correctly.
94See the installation instructions for more information.
95 
96* Developing and Debugging "ComponentBrowserGui".
97
98Always make sure that ComponentRegistry-war grabbed the newest version of the Flex GUI.
99For this you do "mvn install" in ComponentBrowserGui, and
100then compile the backend in ComponentRegistry. Second of all, you should know that you can run and
101debug the Gui from FlashBuilder.  For this you need to edit "Run/Debug" in the project properties.
102For instance,  if a bug to fix appears when fuilfilling the request
103http://localhost:8080/ComponentRegistry/?item=clarin.eu:cr1:c_1288172614011&browserview=comments
104you need to make this uri an "URI to launch". To do this, you duplicate one of the existing
105scenarios in Run/debug menu, and then EDIT the duplicated version by changing its "name"
106and  "URI or path to launch" in the corresponding way.
107
108Make sure to download and install the DEBUG version of the Adobe Flash Player plugin from
109        <https://www.adobe.com/support/flashplayer/downloads.html>
110If you are using Chrome, make sure to also disable the built-in Flash player. See:
111        <https://support.google.com/chrome/answer/108086>
112
113 
114Installation
115------------
116Please see the file called INSTALL
117
118Upgrading
119---------
120Please see the file called UPDATE
Note: See TracBrowser for help on using the repository browser.