mcornejo / common-transit-convention-guarantee-balance

common-transit-convention-guarantee-balance

The public Common Transit Convention Guarantee Balance API with which users can submit requests to query their transit guarantee balance.

Running

To run this Service you will need:

1. Service Manager installed
2. SBT Version >=1.x installed
3. MongoDB version >=4.0 installed and running on port 27017 as a replica set

The easiest way to run MongoDB for local development is to use Docker.

To run MongoDB

> docker run --restart unless-stopped -d -p 27017-27019:27017-27019 --name mongodb mongo:4.0 --replSet rs0

To configure MongoDB to run as a replica set

> docker exec -it mongodb mongo
> rs.initiate()
> exit
> exit

Starting the application:

Launch the service and all dependencies using sm --start CTC_GUARANTEE_BALANCE_API.

This application runs on port 10207.

To run with sbt, stop the Service Manager instance of this service using sm --stop COMMON_TRANSIT_CONVENTION_GUARANTEE_BALANCE before running with sbt run from the project folder.

Testing

Run ./run_all_tests.sh. This also checks code formatting and does coverage testing.

Use sbt test IntegrationTest/test to run only the tests without the additional checks.

License

This code is open source software licensed under the Apache 2.0 License.