Skip to content

ClickChat/clickchat-api

Repository files navigation

ClickChat-REST API

license engine gradle Build Status Coverage Status

Prerequisites

You will need the following things properly installed on your computer.

Installation

Used Gradle, a cross-platform build automation tool that help with our full development flow. If you prefer install Gradle or use a Gradle wrapper inside this project.

  • git clone git@github.com:ClickChat/clickchat-api.git this repository
  • change into the new directory clickchat-api

Build project

./gradlew clean build

Run tests

./gradlew clean test

Generate Javadoc

./gradlew javaDoc

Docker

As we want to run this REST-API in a Docker container, please take a look on a given Dockerfile. The Dockerfile is simple and straightforward.

Build and Running the Docker Image

./gradlew build
docker build --tag="clickchat/rest-api:latest" .
docker run -d -p 8080:8080 -v /my/local/path/logs:/usr/local/tomcat/logs clickchat/rest-api:latest

Running with Docker Compose

Docker Compose is a tool for defining and running complex applications with Docker. With Compose, you define a multi-container application in a single file, then spin your application up in a single command which does everything that needs to be done to get it running.

./gradlew build
docker-compose up

Further Reading / Useful Links

Versions

  • 1.0.0 (current)

License

Apache-2.0

About

The REST-API for ClickChat project

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors