The following apps should be installed before running the application:
- A command line app
- Docker Desktop
Note
For more information regarding the system requirements, etc. refer to the following pages:
Install on Mac
Install on Windows
Install on Linux
In order to run the application, apply the following steps:
- Run Docker desktop.
- Open command prompt window and clone the project from GitHub using the following command:
git clone https://github.com/yildizmy/bank-account-api.git
- Change the current directory to the project directory where the
docker-compose.yml
file is located:
cd bank-account-api
- Run the following command to compose and start up database container of the application on Docker.
docker compose up --build
- After the
axonserver
container starts on Docker, open the project usingIntelliJ IDEA
or another IDE. Then selectJava 21
version viaFile > Project Structure > Project > SDK
menu and run the application.
Important
If Lombok requires enabled annotation processing dialog appears at this stage, click Enable annotation processing button.
At this step, the application starts on http://localhost:8080/ and can be tested by using Postman, etc. For this purpose, see the details on How to test? section.