✅ First-Class Typescript Support
✅ Shared API Gateway
✅ Environments Configuration
✅ CORS
✅ CQRS / Event Sourcing Tooling
✅ prooph board Cody
✅ Keycloak Auth
✅ ESLint
✅ Jest
✅ Github Actions
- Docker
- Node.js 16
- Run
git clone https://github.com/event-engine/serverless-engine my-project
- Run
cd my-project
- Run
cp .env.dist .env
- Run
npm install
- Run
docker-compose up -d
( Check that it works by going to http://localhost:8080/auth/admin, login: dev:dev) - Run
nx preparedb core
- Update the
environment
files based on your configuration - Run
npm run serve
The repository is meant to be used as a project template. Once cloned, it's yours! Change git remote origin and push to your own upstream.
The template is work in progress. We'll move most of the libs into dedicated npm packages as soon as they are stable. So you'll be able to install them later through npm and receive updates. Meanwhile, you can keep a reference to this upstream and pull in changes. Please be aware that if you modify files shipped with the template, you have to resolve merge conflicts yourself.
## Commands
```bash
nx serve <service-name>
nx deploy <service-name>
nx remove <service-name>
nx build <service-name>
nx lint <service-name>
nx test <service-name>
// Use different enviroment
NODE_ENV=prod nx deploy <service-name>
NODE_ENV=stg nx deploy <service-name>
// Run only affected
nx affected:test
nx affected:deploy
// Generate a service
npm run g:service MyService
// Generate an aggregate
npm run g:aggregate MyService MyAggregate ArId
// Generate a command
npm run g:command MyService MyAggregate MyCommand
// Generate an internal/aggregate event
npm run g:event MyService MyAggregate MyEvent
// Generate a public event produced by a service
npm run g:produce-event MyService MyEvent
// Generate a public event consumed by a service
npm run g:consume-event ConsumingService ProducingService MyEvent
// Generate a query
npm run g:query MyService MyQuery Namespaced/ReturnType
// Generate a value object
npm run g:vo MyService MyValueObject /MyNamespace
// Generate a process manager aka event listener
npm run g:process-manager MyService MyProcessManager SomeService.SomeEvent
Login to Keycloak Admin Console with
user: dev pwd: dev
@TODO: Link architecture overview
Start the local Cody server with:
npm run cody
The server listens on the default Cody port 3311
.
How to connect from prooph board to the local Cody server is explained in the prooph board wiki
The Cody implementation used here is specifically designed to make use of the Nx Generators
listed above.
For example when triggering Cody with a command, Cody will take the command information (name, linked aggregate, command metadata),
normalize it and pass it to the g:command
nx generator.
please note: it takes a moment to spin up the generator in the background so give Cody a moment to respond.
Detailed information about working with Cody on the Event Map can be found in the wiki
@TODO: A step by step guide for all available generators (and Cody hooks) is WIP
Card Metadata Templates are available so that all necessary metadata properties are prefilled for the card types.
Import prooph-board-metadata-templates.json in your prooph board for this project.
The pipeline has been configured to run everytime a push/pull_request is made to the main
branch. You should uncomment the deploy-serverless.yml
workflow.
-
Checkout: The
checkout
action is used to checkout the source code. -
Node setup: The
setup-node
action is used to optionally download and cache distribution of the requested Node.js version. -
lint and test: The
lint
andtest
runs only on affected projects. -
Configure AWS credentials: The credentials needed are
AWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
and should be set as Github secrets. -
Each branch should be prefixed with the
environment
name. For example, if we have astg-feature-name
branch and open a pull request to themain
branch, it will setNODE_ENV
tostg
and deploy to this environment.
By merging the pull request to the main
branch, NODE_ENV
is set to prod
, and the deployment is done to production.
The workflow file can have as many environments as you need.
Based on "The Ultimate Monorepo Starter for Node.js Serverless Applications" (https://github.com/ngneat/nx-serverless.git)
Event Engine is maintained by the prooph software team. The source code of Serverless Event Engine is open source. Prooph software offers commercial support and workshops for Serverless Event Engine and Event Storming on prooph board.
If you are interested please get in touch