gitter-badger / multiproject Goto Github PK

Overview

Project is a

http://project.org/

Online Documentation

You can find the latest Project documentation, including a programming guide, on the project web page and project wiki. This README file only contains basic setup instructions.

Building

Project is built using SBT. To build Project and its example programs, run:

./sbt clean compile

(You do not need to do this if you downloaded a pre-built package.) More detailed documentation is available from the project site, at "Building Project".

Running Tests

Setup the environment first using 1. Install "docker" and "docker-compose" 2. Run services for testing docker-compose -f devops/docker-compose-test.yml up

Testing first requires building Project. Once Project is built, tests can be run using:

./sbt test

Please see the guidance on how to run tests for a module, or individual tests.

Coding Style

Refer to Scala Style Guide for project coding conventions. To veriful code style, run:

./sbt scalastyle

Configuration

Please refer to the Configuration guide in the online documentation for an overview on how to configure Project.