Generic platform for large scale collaborative planning
Latest commit 4fbc021 Nov 27, 2018

README.md

xCoLab

Travis build status Codacy grade StackShare

The xCoLab is a generic version of the Climate CoLab, a platform to crowdsource solutions to climate change. The xCoLab is intended to be domain independent and appropriate for solving a wide range of complex social problems.

Getting Started

Prerequesites

  • Java 8
  • MySQL 5.6 or higher

Quick Start

You can set up a copy of the xCoLab like this:

# Create database
mysql -u root -p -e 'CREATE DATABASE xcolab CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;'

# Create the file conf/application.properties with your database credentials
# (use conf/sample-application.properties file as a guide)

# Check prerequesites and set up configuration file
./INSTALL.sh

# Compile the sources, defining database schema
./mvnw compile

# Populate database
cat sql/starter/xcolab-data.sql | mysql -u root -p xcolab

# Run the xCoLab:
./RUN.sh

The components may take a few minutes to start (you can use the tailAll.sh script in scripts/run to tail the log). After that, the xCoLab will be available at http://localhost:18082.

Development setup

For a more comprehensive development setup guide, please check out our setup wiki page.

Architecture

The xCoLab is built with Spring Boot. You can read more about our architecture here.

Contributing

If you notice any issues with the xCoLab, please open an issue in this repository. If you're interested in contributing to this project, check out CONTRIBUTING.md.

Supporters

We use browserstack for cross-browser testing to ensure the xCoLab looks good across all supported browsers and devices: Browserstack