RESTHeart, the Web API for MongoDB
Latest commit 0888061 Dec 13, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Docker added instance-base-url configuration option Dec 12, 2018
bin Add "set -e" to build shell scripts Oct 18, 2018
etc updated netbeans start options with env dev.properties Dec 12, 2018
src ignore jwt test Dec 12, 2018
.gitignore git ingoring hidden dir Nov 27, 2018
.gitmodules Update the HAL git submodule to https://github.com/SoftInstigate/hal-… Jan 27, 2016
.travis.yml git depth: 3 Dec 13, 2018
COMM-LICENSE.txt Update COMM-LICENSE.txt Nov 21, 2018
Dockerfile Upgrade docker image to openjdk:8u181-jre-alpine Nov 22, 2018
ISSUE_TEMPLATE.md Create ISSUE_TEMPLATE.md Apr 11, 2018
LICENSE.txt open sources under the terms and conditions of the GNU AFFERO GENERAL… Nov 16, 2014
README.md [skip travis] Update README Nov 8, 2018
all.policy started document representation transformation logic, i.e. allow to t… Mar 3, 2015
assembly.xml fixed mvn build warn messages about assembly.xml containing root dir … Dec 3, 2015
checkstyle-checker.xml Remove <module name="RedundantThrows"/> Jun 30, 2017
deploy-settings.xml modified: deploy-settings.xml Dec 7, 2017
docker-compose.yml Update comments in docker-compose.yml [skip travis] Nov 12, 2018
licenseheader.txt updated license header Oct 27, 2015
nb-configuration.xml minor change to conf files inline comments + nb 9.0 settings Sep 5, 2018
nbactions.xml updated netbeans start options with env dev.properties Dec 12, 2018
pom.xml Parametric configuration from properties file Nov 27, 2018

README.md

RESTHeart - Web API Server for MongoDB

RESTHeart - Web API Server for MongoDB.

Build Status Maven Central Docker Stars Docker Pulls Join the chat at https://gitter.im/SoftInstigate/restheart

Table of Contents

Summary

RESTHeart connects to MongoDB and opens data to the Web. Clients such as mobile and javascript apps can use the database via a simple RESTful API.

For more information, visit RESTHeart's website and documentation.

Setup

Refer to restheart.org/learn/setup for detailed information on how to setup RESTHeart.

How to Build

Building RESTHeart requires Maven.

Clone the repository and update the git submodules. RESTHeart includes the HAL browser as a submodule:

$ git submodule update --init --recursive

Build the project with Maven:

$ mvn clean package

Integration Tests

To run the integration test suite, first make sure that mongod is running on localhost, on default port 27017 and without authentication enabled — i.e. no --auth option is specified.

$ mvn verify -DskipITs=false

Alternatively, if you have Docker, execute the following script:

$ ./bin/integration-tests.sh 

The script starts a Docker container running MongoDB and then execute the integration tests with Maven. It will clean-up the container at the end.

Maven Dependencies

RESTHeart's releases are available on Maven Central.

Stable releases are available at:

https://oss.sonatype.org/content/repositories/releases/org/restheart/restheart/

If you want to embed RESTHeart in your project, add the dependency to your POM file:

<dependencies>
    <dependency>
        <groupId>org.restheart</groupId>
        <artifactId>restheart</artifactId>
        <version>3.3.0</version>
    </dependency>
</dependencies>

Snapshot Builds

Snapshots are available at Sonatype. If you want to build your project against a development release, first add the SNAPSHOT repository:

 <repositories>
    <repository>
         <id>restheart-mvn-repo</id>
         <url>https://oss.sonatype.org/content/repositories/snapshots</url>
         <snapshots>
             <enabled>true</enabled>
             <updatePolicy>always</updatePolicy>
         </snapshots>
    </repository>
 </repositories>

Then include the SNAPSHOT dependency in your POM:

<dependencies>
    <dependency>
        <groupId>org.restheart</groupId>
        <artifactId>restheart</artifactId>
        <version>3.4.0-SNAPSHOT</version>
    </dependency>
</dependencies>

Maven Site

An automatically generated Maven Site for each build of the master branch is available at: http://softinstigate.github.io/restheart/

Continuous Integration

We continually integrate and deploy development releases to Maven Central with Travis-CI.

RESTHeart's public Docker images are also automatically built and pushed to Docker Hub. The latest tag for Docker images refers to the most recent SNAPSHOT release on the master branch.


Made with ❤️ by SoftInstigate. Follow us on Twitter.