Changeset 6881 for ComponentRegistry


Ignore:
Timestamp:
12/29/15 08:37:24 (8 years ago)
Author:
Twan Goosen
Message:

documentation updated for JS front end

Location:
ComponentRegistry/branches/ComponentRegistry-2.0
Files:
3 edited

Legend:

Unmodified
Added
Removed

  • ComponentRegistry/branches/ComponentRegistry-2.0/CHANGES

    r6871 r6881  
    11Bug Fixes and Features
     2
     3Release ComponentRegistry-2.0 (?? 2016)
     4- New React.JS based front end
    25
    36Release ComponentRegistry-1.14.6 (12 August 2015)

  • ComponentRegistry/branches/ComponentRegistry-2.0/INSTALL

    r5934 r6881  
    77Tomcat.
    88
    9 The package includes a Flex based client that runs client-side in the
    10 user's browser. It is wrapped by an index.jsp page that embeds it and passes
    11 some parameters; it is located in the root of the application directory.
     9The package includes a Javascript (REACT) based client that runs client-side in
     10the user's browser. It is wrapped by an index.html page that loads it and passes
     11some configuration; it is located in the root of the application directory.
    1212
    13 The web application uses the Spring framework and in the current version it
    14 is partly configured through Spring (see below).
     13The application is mainly configured through context parameters (see below).
    1514
    1615Setting up the database

  • ComponentRegistry/branches/ComponentRegistry-2.0/README

    r5794 r6881  
    55-----------
    66The Component Registry stores CMDI metadata components and profiles and
    7 offers a service to list and retrieve them. The BrowserGui is a web
     7offers a service to list and retrieve them. The separate GUI project is a web
    88application displaying available components in the component registry in the
    99correct context: application domain, creator, creation date, version, etc.
    1010The registry offers a hierarchical structure for browsing the components.
    1111
    12 The componentRegistry is set up as a Flex Gui frontend communicating with a
    13 Java based backend (REST service).
     12The Component Registry is set up as a Javascript frontend communicating with a
     13Java based backend (REST service). Sources for the front end can be found, along
     14with more information, at <https://github.com/clarin-eric/react-webpack-comp-reg>.
    1415
    1516The ComponentRegistry is a central software component to the Clarin MetaData
    … …  
    3637- 'ComponentRegistry', a Java project that implements the Component Registry
    3738  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.
     39- 'ComponentSpecFixer', a utility that cleans up the component specifications
     40in the database with 'materialised expansion'.
    4041
    4142How to set up for development/building from source
    … …  
    4344* Creating initial setup files:
    4445
    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.
    4846 - in ComponentRegistry: `mvn eclipse:eclipse` 
    4947        - Generates eclipse configuration
    5048        - For NetBeans, simply open the POM as a project
    5149
    52 When using FlashBuilder to develop the ComponentBrowserGui, create a porject by
    53 "Import a Flex project from an FXP, ZIP, or project folder".
    54 
    55 When using FlashBuilder to develop, make sure to configure the correct Flex SDK. It should
    56 be version 3.6, which you can download for free at <http://www.adobe.com/cfusion/entitlement/index.cfm?e=flex3sdk>.
    57 In addition, you should configure the project to build for Flash player 10.0.0 (instead of default minimum version
    58 provided by SDK).
    59 
    6050* Creating war artifact for local deployment:
    6151
    62  - in ComponentBrowserGui: mvn install
    6352 - in ComponentRegistry: mvn package
    6453 
    65 The ComponentRegistry war will include the flex swf file needed to start the application.
    66 So deploying the resulting war will be enough to start the application.
     54The ComponentRegistry war will include the front end files needed to start the
     55application. So deploying the resulting war will be enough to start the
     56application.
    6757
    6858* Building for specific deployment environment
    … …  
    7868The ComponentRegistry needs the general-component-schema.xsd, which should be found at:
    79691) ComponentRegistry/src/main/binding/ -> that directory has a svn:externals property pointing to the schema.
    80 Do 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?:
    83 The ComponentBrowserGui project needs some swf files which are not in any maven repository I could find.
    84 So install them manually: go to ComponentBrowserGui/libs/ and run the commands in maveninstalllib.txt
     70Do a 'svn propget svn:externals' to see the property. Results in:
     71        'http://svn.clarin.eu/metadata/trunk/toolkit/general-component-schema.xsd general-component-schema.xsd'
    8572
    8673* Developing and Debugging "ComponentRegistry" back-end.
    … …  
    9380it means that you do not have a JNDI resource for the database connection set up correctly.
    9481See the installation instructions for more information.
    95  
    96 * Developing and Debugging "ComponentBrowserGui".
    9782
    98 Always make sure that ComponentRegistry-war grabbed the newest version of the Flex GUI.
    99 For this you do "mvn install" in ComponentBrowserGui, and
    100 then compile the backend in ComponentRegistry. Second of all, you should know that you can run and
    101 debug the Gui from FlashBuilder.  For this you need to edit "Run/Debug" in the project properties.
    102 For instance,  if a bug to fix appears when fuilfilling the request
    103 http://localhost:8080/ComponentRegistry/?item=clarin.eu:cr1:c_1288172614011&browserview=comments
    104 you need to make this uri an "URI to launch". To do this, you duplicate one of the existing
    105 scenarios in Run/debug menu, and then EDIT the duplicated version by changing its "name"
    106 and  "URI or path to launch" in the corresponding way.
     83* Developing the front end:
    10784
    108 Make sure to download and install the DEBUG version of the Adobe Flash Player plugin from
    109         <https://www.adobe.com/support/flashplayer/downloads.html>
    110 If you are using Chrome, make sure to also disable the built-in Flash player. See:
    111         <https://support.google.com/chrome/answer/108086>
    112 
     85See <https://github.com/clarin-eric/react-webpack-comp-reg>.
    11386 
    11487Installation
Note: See TracChangeset for help on using the changeset viewer.