Awesome
AWS Serverless Ecommerce Platform
Status: Work-in-progress. Please create issues or pull requests if you have ideas for improvement.
The Serverless Ecommerce Platform is a sample implementation of a serverless backend for an e-commerce website. Functionalities are split across multiple micro-services that communicate either through asynchronous messages over Amazon EventBridge or over synchronous APIs.
This sample is not meant to be used as an e-commerce platform as-is, but as an inspiration on how to build event-driven serverless microservices on AWS. This makes lots of assumptions on the order flow that might not be suitable for most e-commerce platform and doesn't include many of the features that you might need for this.
Please note that you may incure AWS charges for deploying the ecommerce platform into your AWS account as not all services used are part of the free tier and you might exceed the free tier usage limit. To track costs in your AWS account, consider using AWS Cost Explorer and AWS Billing and Cost Management. You can also set up a billing alarm to get notified of unexpected charges.
<p align="center"> <img src="docs/images/flow.png" alt="High-level flow across microservices"/> </p>Getting started
To install the necessary tools and deploy this in your own AWS account, see the getting started guide in the documentation section.
Architecture
High-level architecture
This is a high-level view of how the different microservices interact with each other. Each service folder contains anarchitecture diagram with more details for that specific service.
<p align="center"> <img src="docs/images/architecture.png" alt="High-level architecture diagram"/> </p>Technologies used
Communication/Messaging:
- AWS AppSync for interactions between users and the ecommerce platform.
- Amazon API Gateway for service-to-service synchronous communication (request/response).
- Amazon EventBridge for service-to-service asynchronous communication (emitting and reacting to events).
Authentication/Authorization:
- Amazon Cognito for managing and authenticating users, and providing JSON web tokens used by services.
- AWS Identity and Access Management for service-to-service authorization, either between microservices (e.g. authorize to call an Amazon API Gateway REST endpoint), or within a microservice (e.g. granting a Lambda function the permission to read from a DynamoDB table).
Compute:
- AWS Lambda as serverless compute either behind APIs or to react to asynchronous events.
Storage:
- Amazon DynamoDB as a scalable NoSQL database for persisting informations.
CI/CD:
- AWS CloudFormation with AWS Serverless Application Model for defining AWS resources as code in most services.
- AWS Cloud Development Kit (CDK) for defining AWS resources as code in the payment-3p service.
- Amazon CodeCommit as a repository to trigger the CI/CD pipeline.
- Amazon CodeBuild for building artifacts for microservices and running tests.
- Amazon CodePipeline for orchestrating the CI/CD pipeline to production.
Monitoring:
- Amazon CloudWatch for metrics, dashboards, log aggregation.
- AWS X-Ray for tracing across AWS services and across microservices.
Backend services
| Services | Description |
|---|---|
| users | Provides user management, authentication and authorization. |
| products | Source of truth for products information. |
| orders | Manages order creation and status. |
| warehouse | Manages inventory and packaging orders. |
| delivery | Manages shipping and tracking packages. |
| delivery-pricing | Pricing calculator for deliveries. |
| payment | Manages payment collection and refunds. |
| payment-3p | Simulates a third party payment system. |
Frontend service
| Services | Description |
|---|---|
| frontend-api | User-facing API for interacting with the services. |
Infrastructure services
| Services | Description |
|---|---|
| pipeline | CI/CD pipeline for deploying the resources in production. |
| platform | Core platform resources for deploying backend services. |
Shared resources
| Name | Description |
|---|---|
| docs | Documentation application for all services. |
| shared | Shared resources accessible for all services, such as common CloudFormation templates and OpenAPI schemas. |
| tools | Tools used to build services. |
Documentation
See the docs folder for the documentation.
Contributing
See the contributing and getting started documents to learn how to contribute to this project.
License
This library is licensed under the MIT-0 License. See the LICENSE file.