Budgeting Service System is a project provides features for tracking and managing budget, money, users, and trading transactions.
- Java 17
- Spring boot 3.3.3
- Swagger
- PostgreSQL
- Thymeleaf
- Bootstrap
- Jquery
- Docker
- Sonar cloud for checking clean code.
Running: You can run this project with Docker container
- Run docker on your local machine.
- Go to the project, run
docker compose pull
if you want to update images or justdocker compose up
onterminal/command promt
, then waiting for project starting- The project is run on:
localhost:8086/sun/
- The postgres container is run on:
localhost:5432
Default user:
username: admin
password: admin
- The PgAdmin is run on:
localhost:8081
Defaul pgAdmin user:
username: admin@sun.com
password: admin
After login toPgAmin -> Register -> Create new -> Create postgres database
- Init the spring boot project, setup README.md, MIT license
- Configure Github action, apply Pull request rules
- Setup packages, initial models and relationships
- Added checkstyle, ci pipeline for checking maven build and test.
- Added docker config to create docker image and container.
- Able to run in local and with docker
Include setup steps for PostgreSQL database connection, and any other necessary configurations.
-
Set up PostgreSQL:
- Install PostgreSQL on your system.
- Create a new PostgreSQL database for your application.
-
Set up environment variable:
- Clone file .env.sample to the new file with name: .env
- Update environment variable in file .env
- Remember checkstyle
./mvnw checkstyle:checkstyle
- Build the Project
./mvnw clean install
- Run the Application
./mvnw spring-boot:run
-
Note
- Test account:
email: sun@sun.com password: test1234
-
Spring Boot Documentation:
-
Swagger Documentation:
-
PostgreSQL Documentation:
-
Thymeleaf Documentation:
-
Bootstrap Documentation:
-
jQuery Documentation:
-
Docker Documentation:
-
SonarCloud Documentation:
-
Maven Documentation:
-
GitHub Actions Documentation:
-
PgAdmin Documentation:
-
Clean Code:
-
Checkstyle Documentation:
-
MIT License:
-
Java 17 Official Documentation:
-
SonarQube Documentation:
-
JPA & Hibernate Documentation: