This is a README file for Account-api. Account-api is a Rest API which allows users to create new current accounts and also get the customer information details.
- Spring Boot
- Java 17
- Spring Data JPA
- GIT ACTIONS
- Restful API
- OpenAPI documentation
- H2 In memory database
- JUnit 5
Please find below the instructions on how to run the application locally.
Before running the application, ensure that you have the following installed on your machine:
- Java Development Kit (JDK) 17 or higher
- Maven build tool
Follow these steps to run the application locally:
-
Clone the repository:
git clone https://github.com/MozThinker/account.git cd account-api
-
Build the application using Maven:
mvn clean install
-
Run the application:
java -jar target/account-api.jar
The application will start and listen on the default port (8080).
-
Access the application Swagger page to test the API:
Open a web browser and visit http://localhost:8080/swagger-ui/index.html to access the application.
To run the automated tests for the application, use the following command:
mvn test
If you have any questions or need further assistance, please contact edson.mutombene@gmail.com.