Skip to content

Latest commit

 

History

History
142 lines (87 loc) · 7.24 KB

Developers_Guide.md

File metadata and controls

142 lines (87 loc) · 7.24 KB
Raw

Developers guide

This is a quick and dirty guide on how to start coding on RODA.

Get the source code

You can easily get the source code by cloning the project into your machine (just need git installed):

$ git clone https://github.com/keeps/roda.git

If you plan to contribute to RODA, you will need to first fork the repository into your own GitHub account and then clone it into your machine. To learn how to do it, please check this GitHub article.

How to build and run

RODA uses Apache Maven build system. Being a multi-module Maven project, in the root pom.xml is declared all the important information to all modules in RODA, such as:

  • Modules to be included in the default build cycle
  • Maven repositories to be used
  • Dependency management (version numbers are declared here and inherited by the sub-modules)
  • Plugin management (version numbers are declared here and inherited by the sub-modules)
  • Profiles available (There are a lot of usable profiles. One that only includes the core projects (core), other that includes user interface projects (wui), other that build RODA wui docker image (wui,roda-wui-docker), and some other ones that, for example, can include external plugins projects that can be integrated in RODA (all)).

Dependencies

The pre-requisites to build RODA are:

Compilation

To compile, go to the RODA sources folder and execute the command:

$ mvn clean package

Use the following command to skip the Unit Tests (faster).

$ mvn clean package -Dmaven.test.skip=true

After a successful compile, RODA web application will be available at roda-ui/roda-wui/target/roda-wui-VERSION.war. To deploy it, just put it inside your favourite servlet container (e.g. Apache Tomcat) and that is it.

More advanced instruction available on the Developer notes page.

How to set up the development environment

Required software

Besides the software needed to build RODA, we recommend the following:

NOTE: This is not a restrictive list of software to be used for developing RODA (as other software, like IDEs, can be used instead of the one suggested.)

How to import the code in IntelliJ IDEA

  1. Start IntelliJ IDEA
  2. Select "File > Open". Then, browse to RODA source code directory on your filesystem and select "Open"
  3. Install "Adapter for Eclipse Code Formatter" plugin in "File > Settings > Plugins"
  4. Set the "Eclipse Code Formatter" configuration to use code-style/eclipse-formatter.xml configuration. Also, set the import order to be java;javax;org;com;.
  5. Select any Java file and do the following actions (these settings will be remembered, there is no need to select these options every time). On the menu: Code > Reformat File..., set Scope: Only VCS changed text; Optimize imports (checked); Code cleanup (checked); Rearrange code (unchecked).
  6. Go to "File > Settings...", "Editor > Code Style > Java", select tab "Imports", set "Class count to use import with '':" 9999, set "Names count to use static import with '': 9999

Code structure

RODA is structured as follows:

/

  • pom.xml - root Maven Project Object Model
  • code-style - checkstyle & Eclipse code formatter files
  • roda-common/ - this module contains common components used by other modules/projects
    • roda-common-data - this module contains all RODA related model objects used in all other modules/projects
    • roda-common-utils - this module contains base utilities to be used by other modules/projects

/roda-core/

  • roda-core - this module contains model, index and storage services, with special attention to the following packages:
    • common - this package contains roda-core related utilities
    • storage - this package contains both a storage abstraction (inspired on OpenStack Swift) and some implementations (ATM a filesystem & Fedora 4 based implementation)
    • model - this package contains all logic around RODA objects (e.g. CRUD operations, etc.), built on top of RODA storage abstraction
    • index - this package contains all indexing logic for RODA model objects, working together with RODA model through Observable pattern
    • migration - this package contains all migration logic (e.g. every time a change in a model object occurs a migration might be needed)
  • roda-core-tests - this module contains tests and tests helpers for roda-core module. Besides that, this module can be added as dependency for other project that have, for example, plugins and ones wants to test them more easily

/roda-ui/

  • roda-wui- this module contains the Web User Interface (WUI) web application and the web-services REST. Basically the components to allow programmatic interaction with RODA.

/roda-common/

  • roda-common-data - this module contains all RODA related model objects used in all other modules/projects
  • roda-common-utils - this module contains base utilities to be used by other modules/projects

Contribute

Source code

  1. Fork the RODA GitHub project
  2. Change the code and push into the forked project
  3. Submit a pull request

To increase the changes of you code being accepted and merged into RODA source here's a checklist of things to go over before submitting a contribution. For example:

  • Has unit tests (that covers at least 80% of the code)
  • Has documentation (at least 80% of public API)

License and Intellectual Property

All contributions to RODA Community Edition are licensed on LGPL v3, which includes an explicit grant of patent rights, meaning that the developers who created or contributed to the code relinquish their patent rights with regard to any subsequent reuse of the software.

Translations

If you would like to translate RODA to a new language please read the Translation Guide.

External plugins

To create new plugins and use them to RODA it is necessary to:

  1. Create a new plugin project, see https://github.com/keeps/roda-plugin-template/
  2. Build the plugin and deploy the resulting zip (expanded) on config/plugins/PLUGIN_NAME/
  3. Publish plugin in market (see instructions)

REST API

RODA is completely controlled via a REST API. This is great to develop external services or integrate other applications with the repository. The documentation of the API is available at https://demo.roda-community.org/api-docs/.

Developing 3rd party integrations

If you are interested in developing an integration with RODA via the REST API, please contact the product team for further information by leaving a question or a comment on https://github.com/keeps/roda/issues.