https://github.com/zephinzer/ms
Microservices
https://github.com/zephinzer/ms
Last synced: 2 months ago
JSON representation
Microservices
- Host: GitHub
- URL: https://github.com/zephinzer/ms
- Owner: zephinzer
- Created: 2018-07-08T08:29:14.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-07T02:02:17.000Z (almost 7 years ago)
- Last Synced: 2025-03-16T15:46:51.790Z (2 months ago)
- Language: TypeScript
- Size: 567 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Microservices & Stuff
This repository is a mono-repo for components, libraries, frameworks and other things (like Docker images) that can be used in applications to quickly bootstrap cloud native applications.
Current packages are:
- [`@usvc/logger-application`](./packages/logger-application): application logger for centralised logging based on `winston`
- [`@usvc/middleware-request-logger`](./packages/middleware-request-logger) : request logging middleware based on `morgan` for `express`
- [`@usvc/request`](./packages/request) : Zipkin instrumented request utility function based on `node-fetch`
- [`@usvc/server`](./packages/server) : bootstrapped server for a microservices architecture based on `express`
- [`@usvc/tracer`](./packages/tracer) : distributed tracing middleware with `zipkin` that integrates with the request and application logger to provide trace IDs in your logs
> We support the latest LTS version of Node only. As of time of publishing this is **8.11.3**.
## Development
### Getting Started
Clone this repository locally and run `npm install` to install the base dependencies.
Then run `lerna bootstrap` to install dependencies in all the sub-packages.
Next, verify that everything's in working order before starting by running `lerna run lint` and `lerna run test`.
### Directory Conventions
All code in packages should be located in a `./src` directory.
After building, all code should be found in `./dist` directory.
### NPM Script Conventions
All packages should have a `lint`, `test` and `build` for running TSLint, running Mocha, and building the package for publishing.
This allows us to run `lerna run lint` to check the code quality across all packages, `lerna run test` to check the correctness of the code across all packages, and `lerna run built` to create distribution packages for publishing onto NPM.
### Publishing
**Do not publish** code yourself. Let the pipeline handle the publishing so that the tags can be updated accordingly to how Lerna does it. Doing an `npm publish` may result in Lerna causing faults for other contributors because the associated tag cannot be found.
### Development Technologies
All code should be written in Typescript and conform to the configurations at the root of this repository - the [`tsconfig.json`](./tsconfig.json) and the [`tslint.yaml`](./tslint.yaml) files.