https://github.com/3l-d1abl0/apparel-galaxy
A Simple E-Commerce Store based on Microservices
https://github.com/3l-d1abl0/apparel-galaxy
docker e-commerce ecs ecs-fargate fastapi golang jest microservices mongodb pytest
Last synced: 3 months ago
JSON representation
A Simple E-Commerce Store based on Microservices
- Host: GitHub
- URL: https://github.com/3l-d1abl0/apparel-galaxy
- Owner: 3l-d1abl0
- Created: 2024-09-17T18:33:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-14T16:12:21.000Z (over 1 year ago)
- Last Synced: 2025-04-06T00:43:21.030Z (about 1 year ago)
- Topics: docker, e-commerce, ecs, ecs-fargate, fastapi, golang, jest, microservices, mongodb, pytest
- Language: TypeScript
- Homepage:
- Size: 396 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Apparel Galaxy
Apparel Galaxy is a simple e-commerce APIs built using microservice Architecture. It queries apparel stored over MongoDB Cloud.
User can create account and browser products and Order them.
Can be deployed over localhost or cloud using containers (Docker/Kubernetes)
I have personally deployed it via AWS Fargate on ECS Clusters.
Following Diagram is just an illustration on AWS ECS Architecture:
Image Source [AWS](https://docs.aws.amazon.com/images/AmazonECS/latest/developerguide/images/overview-fargate.png)
**Apparel Galaxy**'s overall architecture when deployed on ECS would look like:
The diagram only shows some of the services available.
Following is the breakdown of the the Services:
### 1. Auth Service
Authentication Service handles the authentication and authorization of user over the e-commerce platform. It uses Json Web Token (JWT) grant identity to user once they are registered to the Platform. It exposes the following endpoints:
- GET /ping
returns a 'pong' from the service
- POST /register
Registers the user onto the Platform.
- POST /login
logs the valid user onto the System. Returns a token in return.
- POST /onboard
Registers a user onto the Platform as a Admin
> More details on the AuthService README
### 2. Product Service
Product Service handles all the request handling the queries for Products. It exposes the following endpoints:
- GET /PING
returns a 'pong' from the service
- GET /products/search
search for products with a specific query
- GET /products
browse products
- GET /products/< id>
get a particular product with an ID
> More details on the ProductService README
### 3. Order Service
Order Service is responsible for serving order details for users and handle order request. Verification of order after failure/success of Payment.
- GET /ping
returns a 'pong' from the service
- GET /orders
lists the past orders for a user
- GET /orderFailure
handles the process when an payment fails
- GET /orderSuccess
handles the process when the payment fails
> More details on the OrderService README
### 4. Cart Service
Cart Service is responsible for handling user's cart operation and checking out the cart for order.
- GET /ping
returns a 'pong' from the service
- GET /cart
fetches the cart content for the users
- POST /cart
handles addition of items to the cart.
- DELETE /cart
handles the deletion of items from cart or deletion of entire Cart.
> More details on the CartService README
## Deployment 🚀🚀🚀
- Refer to the [Deployment Docs](https://github.com/3l-d1abl0/apparel-galaxy/tree/48e86c04ff3d908c8ea8d89de8d3423318cbde89/deployment) for deployment on localhost, docker or AWS Elastic Container Service (ECS)
## Built Using
- Python v3.12.4
- FastAPI v0.114
- NodeJS v21.7.3
- Express v4.21.0
- Typescript v5.6.2
- Golang v1.22.0
- Gin-Goinc v1.10.0
- MongoDB Cloud