Sagahead.io opinionated monorepo e-commerce blueprint

Cloud native, microservice architecture based, e-commerce platform blueprint

Stack

• NodeJS
• Vscode
• Yarn v2 (berry) with pnp
• Typescript
• TypeGraphql
• Fastify + Mercurius
• Auth0
• Postgres
• Docker, docker-compose
• Localstack (for free development using aws)
• React
• Redis

Installation

requirements

• vscode
• node >=14
• docker-compose

run

• git clone
• docker-compose up -d
• yarn build
• yarn start

Justification

The idea is to have e-commerce type api/frontends blueprint. Over the years of microservices development, from time to time I was running into distributed monoliths, devops nightmares, sharing is bad until we go full wet, cyclic dependencies, one service can break everything and all other problems that microservices brings to the world, with this blueprint I would like to tackle the problems my way.
This monorepo blueprint is based on microservices architecture paradigm. Decoupled services that has two adapters to talk, one synchronous another asynchronous or only asynchronous. The downstream services are accessible only via api gateway that is based on graphql. Api gateway is federating downstream schemas and generating the api schema for the frontends. This approach helps to release API changes without breaks in the frontends.
Services own the data and can’t share databases between, database per service approach. Although services are decoupled, there is still tiny wires between them graphql api-gateway allows to delegate synchronous schema handlings to other services. Events/commands that passes through pubsub has some sort identification for good traceability, something like event/command DTO’s. Even if microservice world means everything decoupled, with the help of yarn v2 (berry) is easier to share libs that is common for all the services like server configuration libs, loggers and other utility functions.
One more important thing in this blueprint – to achieve centralized auth handling, field level auth and decorators. For this to implement properly I am relying on auth0, redis, authGuard middlewares. Thanks to smart fastify-gql context sharing approach, it is possible to implement field level auth this way.
There are/will be more good things in this blueprint. Subscriptions and websockets, api schema generation, frontends state handling without redux, saga’s and orchestration examples for distributed workflows or long running tasks, pubsub based on RabbitMQ. Maybe a generation CLI in the future for easier maintenance less of copy pasting.
This is opinionated blueprint.
An alpha version, development in progress.
The blueprint is inspired by the book: Microservices Patterns

Development Docs

TODO…
folders structure

. #root
├── commons
│   ├── amqp-bus #shared lib
│   │   ├── src
│   ├── amqp-subscriptions  #shared lib
│   │   └── src
│   ├── build-federated-schema  #shared lib
│   │   └── src
│   ├── events-commands  #shared lib
│   │   └── src
│   ├── federated-server  #shared lib
│   │   └── src
│   ├── integrate-auth0  #shared lib
│   │   └── src
│   └── logger  #shared lib
│       └── src
├── frontends
│   └── web  #frontend react web
│       └── src
└── services
    ├── api-gateway # backend service api gateway based on gql
    │   └── src
    ├── auth # backend service central auth
    │   └── src
    └── workflows # backend service workflows based on @node-ts/bus
        └── src

Ideas

• gitops approach using jenkinsx, helm, eks or terraform/terragrunt atlantis and argocd
• frontends served by s3 bucket
• e-wallet on etherum blockchain

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sagahead-io/ecommerce-blueprint/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The lib is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the ecommerce-blueprint project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.