Generic platform for large scale collaborative planning
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea Update tracking service port Sep 16, 2018
.mvn/wrapper Downgrade maven wrapper to 3.5.0 Feb 5, 2018
conf Update sample config file May 16, 2018
microservices [COLAB-2966-futures] Added support for contest page voting, and limit… Feb 16, 2019
other/GeoLiteCity Archive old design files Aug 22, 2018
scripts Fix custom run scripts Sep 16, 2018
sql Add missing configuration values to starter Nov 11, 2018
util Merge branch 'refactoring/COLAB-2926-remove-service-namespace' into d… Nov 30, 2018
view
.editorconfig Fixed indentation in .editorconfig Apr 28, 2017
.gitignore Add IntellIJ data sources config to .gitignore Jul 28, 2018
.travis.yml Update travis to use openjdk Sep 4, 2018
CONTRIBUTING.md Fix typo Jan 24, 2018
INSTALL.sh Update setup instructions Jul 30, 2018
LICENSE Update copyright notice Jan 24, 2018
README.md Update setup instructions Jul 30, 2018
RUN.sh Improve log message in run script May 16, 2018
atlassian-ide-plugin.xml added install scripts for windows. Updated service layer build number… Dec 8, 2014
mvnw Added maven wrapper to simplify setup Jul 11, 2017
mvnw.cmd Added maven wrapper to simplify setup Jul 11, 2017
pom.xml [COLAB-2921] Add sentry error monitoring Oct 3, 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