ptanlam / eshop

An e-commerce application applying micro-services architecture and developing in TDD way.

eShop

An e-commerce application applying micro-services architecture.

Services

Name	Framework	Database
Catalog Service
Basket Service
Payment Service
Notification Service
Vendor Service
Discount Service
Coupon Service
Ordering Service
Review Service
Storage Service
Currency Service

Front-ends

Name	Technology
Customer web client
Vendor web client
Adminstrator web client

Others

Name	Technology
Containers managing
API Gateway	Kong Gateway
Async Communication (M2M)
Sync Communication (M2M)	gRPC
Identity Provider	Auth0
Payment
CI/CD Pipeline
Storage and Shared Database

Architecture

Prerequisites

1. Docker Desktop
2. AWS S3 credentials
3. Stripe publishable and secret keys
4. Currency exchange rate API key
5. Auth0 client-id, domain and scope
6. Switch to Linux containers on Windows only

Optionals

1. Unix kernel environment (Windows users can use WSL2)
2. Shell terminal

Instructions

1. Open your terminal (Linux Shell for the sake of simplicity)
2. Change directory to this repository: cd eshop
3. Export environment variables:
   1. export AWS_REGION=your-aws-credentials
   2. export AWS_ACCESS_KEY_ID=your-aws-credentials
   3. export AWS_SECRET_ACCESS_KEY=your-aws-credentials
   4. export AWS_BUCKET=your-aws-credentials
   5. export STRIPE_PUBLISHABLE_KEY=your-stripe-credentials
   6. export STRIPE_SECRET_KEY=your-stripe-credentials
   7. export EXCHANGE_RATE_API_KEY=your-exchange-api-key
   8. export AUTH0_CLIENT_ID=your-auth0-credentials
   9. export AUTH0_DOMAIN=your-auth0-credentials
   10. export AUTH0_SCOPE=your-auth0-credentials
4. This step is just required for the first run, build projects:
   1. docker compose build catalog-service basket-service review-service
   2. docker compose build storage-service vendor-service currency-service
   3. docker compose build discount-service coupon-service
5. This step is just required for the first run, initialize databases: chmod +x ./bootstrap.sh && ./bootstrap.sh
6. Start application: chmod +x ./start.sh && ./start.sh
7. Navigate to:
   1. Customer web client
   2. Vendor web client
   3. Administration web client