This project consists of two main microservices: Authorization Service and Products Service, providing a secure way to manage a product catalog. All traffic is routed through an Nginx API Gateway for simplified access and security.
Ensure your development environment meets the Spring Boot 4 requirements:
- Java JDK 21 (Required for both the services and the SonarQube scanner)
- Docker & Docker Compose
-
Clone the repository:
git clone https://github.com/AhmedSM1/Store_console.git
-
Spin up the infrastructure: This will start the databases, management tools, the microservices, and the Nginx Gateway:
#This will Grant execution permissions for kibana-setup container chmod +x scripts/kibana-setup.sh docker-compose up -d -
Run Code Quality Analysis (SonarQube) Once the containers are healthy, run the automated scan script:
# Grant execution permissions chmod +x sonar-setup.sh # Run the scan (Requires Java 21) ./sonar-setup.sh
Open your browser at: http://localhost:9000 Login:
admin/ Password:admin -
View Kibana Logs (Kibana)
Open your browser at: http://localhost:5601/app/discover
-
View Swagger docs
- For Auhtorization service swagger: Open your browser at: http://localhost:8080/authorization/swagger-ui/index.html
- For Producrs service swagger: Open your browser at: http://localhost:8080/products/swagger-ui/index.html
The system uses an Nginx API Gateway as the single entry point. You only need to interact with port 8080 to reach both microservices.
| Component | Gateway Route | Internal Port | Database | Responsibilities |
|---|---|---|---|---|
| API Gateway | http://localhost:8080 |
80 |
- | Central Entry Point & Routing |
| Auth Service | /authorization |
8070 |
PostgreSQL | User management, RBAC, JWT |
| Products Service | /products |
8080 |
MongoDB | Inventory management, Secure CRUD |
| pgAdmin | - | 5050 |
- | PostgreSQL GUI |
| Mongo Express | - | 8081 |
- | MongoDB GUI |
| Kibana | - | 5601 |
- | Kibana dashboard |
sequenceDiagram
autonumber
actor User as 👤 User / Employee
participant Gateway as 🌐 API Gateway
participant Auth as 🔒 Auth Service
participant Postgres as 🐘 PostgreSQL
participant Product as 📦 Product Service
participant Mongo as 🍃 MongoDB
Note over User, Postgres: User Management (Auth Service)
User->>Gateway: POST /authorization/users (Register)
Gateway->>Auth: Process Registration
Auth->>Postgres: INSERT User Data (hash, email, role)
Postgres-->>Auth: Success
Auth-->>User: 201 Created
User->>Gateway: POST /authorization/login
Gateway->>Auth: Validate Credentials
Auth->>Postgres: SELECT User by Username
Postgres-->>Auth: User Record Found
Auth-->>User: 200 OK (JWT AccessToken)
Note over User, Mongo: Product Management (Product Service)
User->>Gateway: POST /products/products (Create Product)
Gateway->>Product: Forward Request with JWT
activate Product
Note right of Product: Internal Check: Does JWT<br/>have Admin/Emp Authority?
Product->>Mongo: Save Product Document
Mongo-->>Product: Success
Product-->>User: 201 Created (Product ID)
deactivate Product
Note over User, Mongo: Order Flow (Product Service)
User->>Gateway: POST /products/orders (Place Order)
Gateway->>Product: Forward Request with JWT
activate Product
Note right of Product: Internal Check: Authority exists?
rect rgb(245, 245, 245)
Note right of Product: Processing Final Amount:<br/>Calculate Discounts & Rewards
end
Product->>Mongo: Insert Order (Status: PENDING)
Mongo-->>Product: Success
Product-->>User: 201 Created (Order Pending + Final Amount)
deactivate Product
Note over User, Product: Order Confirmation
User->>Gateway: PUT /products/orders/confirm?orderId=...
Gateway->>Product: Confirm Order
Product->>Mongo: Update Order (Status: CONFIRMED)
Mongo-->>Product: Success
Product-->>User: 200 OK (Order Confirmed)
classDiagram
class User {
+String username
+String password
+String email
+String phone
+login()
+getProfile()
}
class Admin {
+createEmployee()
+createProduct()
}
class Employee {
+createProduct()
+calculateDiscount()
}
class Customer {
+String address
+String city
+register()
+placeOrder()
}
class Product {
+String id
+String name
+String category
+double price
+int quantity
}
class Order {
+String orderId
+List products
+String status
+double totalAmount
+confirmOrder()
}
%% Relationships
User <|-- Admin
User <|-- Employee
User <|-- Customer
Customer <|-- AffiliateCustomer
Customer <|-- LoyalCustomer
Customer "1" -- "*" Order : places
Order "1" -- "*" Product : contains
note for Employee "30% Disc on non-groceries & $5 back per $100"
note for AffiliateCustomer "10% Disc on non-groceries & $5 back per $100"
note for LoyalCustomer "5% Disc on non-groceries & 5 back per $100"
With the API Gateway enabled, all service requests are prefixed by the service name.
- Base Gateway URL:
http://localhost:8080 - Auth Service:
http://localhost:8080/authorization/... - Products Service:
http://localhost:8080/products/...
This project is designed for automated testing using Postman Environments.
- Import the Collection: Import
store_collection.json. - Import the Environment: Import
store_environment.json. - Update Base URL: Ensure your Postman environment variable
urlis set tohttp://localhost:8080. - Automated Authentication:
- The
Loginrequest contains a Tests script that automatically captures the JWT and updates the{{token}}variable. - All subsequent requests use this token automatically.
- The
| Tool | URL | Credentials |
|---|---|---|
| pgAdmin (Postgres) | http://localhost:5050 | admin@admin.com / admin |
| Mongo Express | http://localhost:8081 | Disabled (Default) |
Note: In pgAdmin, use host store-postgres, port 5432, and maintenance DB auth_db to connect.
Navigate to the service directory and run:
# For Authorization Service
cd authorization
mvn clean test
# For Products Service
cd ../products
mvn clean testDetailed JaCoCo HTML reports are generated at:
authorization/target/site/jacoco/index.htmlproducts/target/site/jacoco/index.html
- Gateway: Nginx (Alpine)
- Auth Service: Spring Boot, PostgreSQL, JWT.
- Products Service: Spring Boot, MongoDB.
- Network: All containers communicate over a private bridge network named
store-network.