This is the basic skeleton for microservices using ExpressJS - TypeScript - Sequilize. what I am trying to do is that if I could create a simple structure with all the must-have-components of a microservice and build a CI/CD, Testing and development features around it then we can easilly use this skeleton and build services faster.
I highly encourage the developers to contribute and simple way is that you have to make a seperate branch and make a pull request in the end. Please make sure it passes all the tests and linters. other wise the pull-request will be rejected.
There are plenty of things we need while building the nodejs microservice. and not everyone needs all of them but most of them are important. so we planed to add following features/tools
- Elastic APM / OpenAPI tracing
- Logstash Logging / Centralize logging solution
- Redis Cluster Connection
- and much much more.
name your branch wisely. example branch names are feature-events-sourcing and fixed-issue-no-1234. please use dashed-names.
I have used the standard readme structure and everything beyond this line is not the part of this project. I will write it later.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them.
Give examples
A step by step series of examples that tell you how to get a development env running.
Say what the step will be
Give the example
And repeat
until finished
End with an example of getting some data out of the system or using it for a little demo.
Simply clone the repository, set the database config and you will be good to go.