Skip to content

Commit

Permalink
Updated Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
arpitkhandelwal1984 committed Jun 26, 2018
1 parent 6914209 commit f538da3
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,38 +26,40 @@ Starter kit for booting up the development of a API oriented and transaction bas
## Running the server locally
The BankOfSpring application can be started using your favourite IDE and its run configuration support. If you are a terminal savvy, please use the following command -

''''
````
mvn spring-boot:run
''''
````

## Docker
BankOfSpring supports docker container out of the box. This boilerplate is meant to cater to both web based applications as well as scalable micro services written in Java. Please select one of the following two ways to use docker to build and run the application -

** Dockerfile **
**Dockerfile**

To build a fresh image, use -
''''
````
docker build -t bankofspring .
''''
````
To run the new image, use -
''''
````
docker run -p 8080:8080 bankofspring
''''
````

**Docker-Compose**

** Docker-Compose **
To build a fresh image, use -
''''
````
docker-compose build
''''
````
To run the new image, use -
''''
````
docker-compose up
''''
````

## Swagger Documentation
Swagger documentation is in-built in this starter-kit and can be accessed at the following URL -
''''
````
http://<host-name>:8080/swagger-ui.html
''''
````

## Unit test cases

Expand Down

0 comments on commit f538da3

Please sign in to comment.