Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derekbar90/catalyst
Typescript NodeJS Microservices Boilerplate with Generator CLI - Moleculer, GraphQL, REST, OAuth2, Jaeger, Grafana, Prometheus, Ory Hydra, Ory Keto w/ Access Control middleware, Moleculer-DB GraphQL mixin, Pug, Redis, sibling client repo (login, persistance layer, react-native-web, ios, android)
https://github.com/derekbar90/catalyst
boilerplate catalyst docker generator grafana graphql jaeger microservices moleculer nodejs ory ory-hydra ory-keto prometheus pug redis traefik typescript
Last synced: about 1 month ago
JSON representation
Typescript NodeJS Microservices Boilerplate with Generator CLI - Moleculer, GraphQL, REST, OAuth2, Jaeger, Grafana, Prometheus, Ory Hydra, Ory Keto w/ Access Control middleware, Moleculer-DB GraphQL mixin, Pug, Redis, sibling client repo (login, persistance layer, react-native-web, ios, android)
- Host: GitHub
- URL: https://github.com/derekbar90/catalyst
- Owner: derekbar90
- Created: 2019-09-23T14:30:02.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T08:59:11.000Z (over 1 year ago)
- Last Synced: 2024-06-16T21:32:13.281Z (3 months ago)
- Topics: boilerplate, catalyst, docker, generator, grafana, graphql, jaeger, microservices, moleculer, nodejs, ory, ory-hydra, ory-keto, prometheus, pug, redis, traefik, typescript
- Language: TypeScript
- Homepage:
- Size: 10.4 MB
- Stars: 61
- Watchers: 7
- Forks: 13
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-moleculer - Catalyst - NodeJS Microservices Boilerplate - Typescript NodeJS Microservices Boilerplate with Generator CLI - Moleculer, GraphQL, REST, OAuth2, Jaeger, Grafana, Prometheus, Ory Hydra, Ory Keto w/ Access Control middleware, Moleculer-DB GraphQL mixin, Pug, Redis, sibling client repo (login, persistance layer, react-native-web, ios, android) (Examples / Repositories)
README
# Project Catalyst
Project Catalyst is a microservices framework which allows you to create and deploy secured base application development tools within 10 minutes.
## Initial setup
- Pull submodule for the catalyst client.
- ```git submodule update --init --recursive```
- `Note`: If you don't want to use the catalyst client then you can remove the service section from the docker-compose along with it's volume definition.
- Run `npm i` first to setup any global dev tools which are used. These are defined in the `package.json` which is at the root of the project.
- Setup acme config with your email at /traefik/traefik.toml
- Run ```chmod 600 traefik/acme.json```
## Ports Configs
These can also be viewed by looking at the `docker-compose.yaml` file in the project root. Any exposed service is then label within this file for Traefik configuration
|Port |Service |
|----------------|-------------------------------|
|3000 |Traefik Main |
|3001 |Traefik Admin |
|4444 |Hydra Main |
## `Required Setup Step: .ENV Config Setup`
If you have not setup a .env file you must create one at the root of the project.
Example:
```
HOST_NAME={YOUR_HOSTNAME}
POSTGRES_HOST==#############
POSTGRES_USER==#############
POSTGRES_PORT=5432
POSTGRES_PASSWORD==#############
POSTGRES_DB=postgres
ADMIN_OAUTH2_CLIENT_ID==############# -- !!CHANGE THIS VALUE!!
ADMIN_OAUTH2_CLIENT_SECRET=############# -- !!CHANGE THIS VALUE!!
EMAIL_API_KEY==############# !! mailgun specific, use nodemailer config for help !!
EMAIL_DOMAIN==############# !! mailgun specific, use nodemailer config for help !!
EMAIL_PROVIDER==#############
```
`If you are running the catalyst-client/using the consumer-app.json config to power a app, you'll want to modify/update the callbacks per deployment env`
#### Notes
`HOST_NAME`: hostname of choice to have the stack run on, if you do this: make sure that LetsEncrypt can do a hostname validation, certbot can be run via nginx if you need it but traefik will auto setup the SSL cert and hold it on a volumes in `traefik/acme.json`. You may need to set the permission on this folder to 600
## Global Make Commands
- `make start-stack` - build and launch all containers
- `make start-stack-metrics` - build and launch all containers with metrics
- Tip: You need to restart any running services with a updated docker-compose.env where METRICS_ENABLED=true
- `make stop-stack` - stop all launched containers
- `make dbash SVC=SERVICE_NAME` - takes `SVC` arg and creates a bash command line inside the running service
- `make dlog SVC=SERVICE_NAME` - takes `SVC` arg and logs with following and tails the last 400 lines of a service
- `start-code-server` - create web served version of VS Code, helpful for working on an iPad (iOS 13 preferrable)
## Global NPM Scripts
### Hygen Specific:
- `npm run hygen` - This is a link to the executable bin/script for the hygen generator library.
- `npm run hygen generator help` - View generator help
- `npm run hygen generator new [name]` - Create new generator
- `npm run hygen generator new-with-prompt [name]`: Create new generator w/ prompt
### Project Specific:
- `npm run hygen service new`: Create new service
## Per Service NPM scripts
- `npm run dev` - Start development mode (load all services locally with hot-reload & REPL)
- `npm run build`- Uses typescript to transpile service to javascript
- `npm start` - Start production mode (set `SERVICES` env variable to load certain services) (previous build needed)
- `npm run cli`: Start a CLI and connect to production. Don't forget to set production namespace with `--ns` argument in script
- `npm run lint` - Run TSLint
- `npm run ci` - Run continuous test mode with watching
- `npm test` - Run tests & generate coverage report
- `npm run dc:up`: Start the stack with Docker Compose
- `npm run dc:down`: Stop the stack with Docker Compose
# Roadmap
1.0 Goals:
- [x] User Management
- [x] User Registration
- [x] User Login
- [x] Account Verify
- [x] Password Reset
- [ ] Forgot Username
- [x] Global User Registration Event
- [x] Database Setup
- [x] Local dev support container
- [x] Configurable db adapter
- [x] Migrations support
- [x] Bootstrap on service at launch
- [ ] Metrics Services
- [x] Prometheus setup
- [x] Grafana setup at /grafana
- [x] Metrics config setup for services
- [ ] Add to template generation
- [ ] Tracing Services
- [x] Jaeger setup at /jaeger
- [x] Tracing config setup for services
- [ ] Add to template generation
- [x] SSL Support
- [x] LetsEncrypt Setup
- [x] Traefik Setup at :8080/dashboard
- [ ] Domain setup instruction in README.md
- [x] Redis Cache
- [x] API Gateway
- [x] REST
- [x] GraphQL
- [x] OAuth 2.0
- [x] implicit flow
- [x] consent flow
- [x] auth code flow
- [x] ORY Keto
- [x] Email Suport
- [x] Service setup w/ mailgun provider
- [x] Templating
- [x] User registration event consumption for welcome email
1.1 Goals:
- [ ] Kubernetes configuation
- [ ] Helm charts for each base service
- [ ] Jenkins X Support
1.2 Gaols:
- [ ] Social Login
- [ ] Lerna multi repo support
- [ ] One time password support
## Links to main libraries to understand
-- `Code Generator`: [Hygen](https://www.hygen.io/)
-- `Router`: [Traefik](https://docs.traefik.io/)
-- `Containers`: [Docker](https://docker.com/)
-- `Microservice Framework`: [Moleculer](http://moleculer.services/)
-- `Message Bus`: [NATS](https://nats-io.github.io/docs/)
-- `Database`: [Postgresql](https://www.postgresql.org/)
-- `Metrics`: [Prometheus](https://prometheus.io/)
-- `Tracing`: [Jaeger](https://www.jaegertracing.io/)
-- `OAuth2`: [Hydra](https://www.ory.sh/hydra)
-- `GraphQL`: [GraphQL](https://graphql.org/)
-- `PassportJS`: [PassportJS](https://passportjs.org)
-- `Kubernetes Middleware` https://gist.github.com/icebob/c717ae22002b9ecaa4b253a67952da3a