KuenyaWZ API
Spring Boot API for KuenyaWZ project.
Main Repository
This project is to be implemented for our KuenyaWZ site.
Features/checklist
- [ ] Entities - Controllers - Services - Repositories
- [x] Account
- [ ] Product
- [ ] Variant (subset of Product)
- [ ] Order
- [ ] Order Item (subset of Order)
- [ ] Transaction
- [ ] Likes
- [ ] CustomSchedule
- [ ] Authentication/Authorization
Should be noted that we'll need to implement integration of methods
for the actual website business logic.
API documentation
Refer to this Swagger Documentation
Prerequisites
- Java JDK 21 (This project has not been compiled to JAR yet)
- Maven 3.9.9+
- PostgreSQL XX.XX
Docker
Default configurations
- Database: H2 in memory
- Port: 8081
- Base URL:
http://localhost:8081/api/v1
Installing and running application
- Clone this repository
- Change directory to the cloned repository
- Run
mvn spring-boot:run
Running with specific profile
Make sure the profile requirement is met. For example, to run with postgres profile,
please make sure you have PostgreSQL installed and running with the provided .ENV
.
- Add profile to environment variable:
set SPRING_PROFILES_ACTIVE=postgres
- Run
mvn spring-boot:run