development.rst

Development of Doma

Note

This document is written for the developers of Doma.

Before You Start

To build you will need Git and JDK 8. Be sure that your JAVA_HOME environment variable points to the jdk1.8.0 folder extracted from the JDK download.

Get the Source Code

$ git clone https://github.com/domaframework/doma.git
$ cd doma

Build from the Command Line

$ ./gradlew build

Format the Source Code

We use google-java-format 1.7 for code formatting.

Command Line

Use the Spotless gradle plugin:

$ ./gradlew spotlessApply

IntelliJ

Use the google-java-format IntelliJ plugin.

Eclipse

Use the google-java-format Eclipse plugin.

Continuous Integration

We use Travis CI for CI. All pull requests to master brunch are tested on Travis CI.

https://travis-ci.org/domaframework/doma

Documents

We use Sphinx to generate documents. To use Sphinx you will need Python.

Set up an environment

$ cd docs
$ pip install -r requirements.txt

Generate HTML files

Execute the sphinx-autobuild command in the docs directory:

$ sphinx-autobuild . _build/html

Visit the webpage served at http://127.0.0.1:8000.