💶 Currency BG HTTP API
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.
.circleci
docs
gradle/wrapper
schemas
src
.gitattributes
.gitignore
.travis.yml
HISTORY.md
LICENSE
README.md
build.gradle
gradlew
gradlew.bat
settings.gradle

README.md

Currency BG Server

CircleCI

Currency BG RESTful web service

HTTP API documentation

Requirements

  • JDK 1.8
  • MySQL 5.5
  • Tomcat 8 or Jetty 9

Development

Install Gradle or use the ./gradlew script.

If you use Eclipse, you may generate the Eclipse project files by running:

./gradlew eclipse

To build the project run:

./gradlew build

Deployment

Create a MySQL database and use the DDL in schemas to create all required tables.

In order to deploy a local test version the following Java properties need to be setup, i.e.,

CBG_CFG_PATH=<directory path> // path to where server configurations will be saved
DB_HOST=<mysql hostname>
DB_PORT=<mysql port>
DB_NAME=<mysql database>
DB_USERNAME=<mysql user>
DB_PASSWORD=<mysql password>

To run locally:

./gradlew tomcatRun \
  -DCBG_CFG_PATH=<directory path> \
  -DDB_HOST=<host> -DDB_PORT=<port> -DDB_NAME=<database> \
  -DDB_USERNAME=<username> -DDB_PASSWORD=<password> 

To access the API open:

http://localhost:8090/api

License

GNU AGPL