Clone this project to quickly create your own BIP-0171 compliant server
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
LICENSE
README.md
checkstyle_configuration.xml
logo.png
pom.xml

README.md

Cerise BIP-0171

Cerise server template.

This project helps you to quickly create your own BIP-0171 compliant server.

Clone the project.

git clone git@github.com:straumat/cerise-server-template.git

Implement code.

Enumerating supported currency-pair tokens.

Implement method getSupportedCurrencyPairTokens(...) in MySupportedCurrencyPairTokensService or create your own service implementing SupportedCurrencyPairTokensService.

Unit tests are here : MySupportedCurrencyPairTokensTest.

Currency-pair information.

Implement method getCurrencyPairInformation(...) in MyCurrencyPairInformationService or create your own service implementing CurrencyPairInformationService.

Unit tests are here : MyCurrencyPairInformationServiceTest.

Current exchange rate.

Implement method getCurrentExchangeRate(...) in MyCurrentExchangeRateService or create your own service implementing CurrentExchangeRateService.

Unit tests are here : MyCurrentExchangeRateTest.

Historical exchange rates.

Implement method getHistoricalExchangeRates(...) in MyHistoricalExchangeRatesService or create your own service implementing HistoricalExchangeRatesService.

Unit tests are here : MyHistoricalExchangeRatesTest.

Run it.

Once in the cerise-server-template directory, you can run the server with the mvn spring-boot:run command.

You can access the API at this address : http://localhost:8080/swagger-ui.html.

Package it.

Once in the cerise-server-template directory, package it with the mvn package command. This will produce a file named cerise-server-template.jar in the target directory.

You can run the server with the command java -jar cerise-server-template.jar.