Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joktec/joktec-monorepo
The most powerful to build microservice with monorepo
https://github.com/joktec/joktec-monorepo
lerna monorepo nestjs nx template typescript
Last synced: 20 days ago
JSON representation
The most powerful to build microservice with monorepo
- Host: GitHub
- URL: https://github.com/joktec/joktec-monorepo
- Owner: joktec
- License: mit
- Created: 2022-11-09T15:30:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T14:35:20.000Z (about 1 year ago)
- Last Synced: 2023-12-19T15:55:40.438Z (about 1 year ago)
- Topics: lerna, monorepo, nestjs, nx, template, typescript
- Language: TypeScript
- Homepage:
- Size: 22.5 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JokTec - The most powerful to build microservice
JokTec is a powerful and easy-to-use library designed to approach microservice architecture. It offers a skeleton that can be extendable and is compatible with NestJS framework. Whether you're a beginner or an experienced developer, JokTec can help you to organize and architect microservice simply and quickly.
## 🚀 Quick Start
### 1/ Prerequisites
- node >= 14.x.x
- yarn >= 1.22.x - Prefer recommended than npm
```shell
$ npm install -g yarn
```
- lerna (global) - Optional on Unix, required on Window
```shell
$ npm install -g lerna
```
- nx (global) - Optional on Unix, required on Window
```shell
$ npm install -g nx
```
- @nestjs/cli (global) - Optional on Unix, required on Window
```shell
$ npm install -g @nestjs/cli
```
### 2/ Install dependencies
Stand on the root project and run:
```shell
$ yarn install
# OR
$ yarn
```
It will be install all dependencies for all packages/ or apps/
### 3/ Build project/packages
```shell
# Build all packages in project (recommended for first installation)
$ yarn build
# Build a single package
$ yarn build --scope @joktec/core
# Build multiple packages
$ yarn build --scope @joktec/core --scope @joktec/graphql
```
P/S:
- After build core package, it will be link to other service automatically. So you don't need to copy build dir (/dist) to node_modules any more
- If don't have any changes in packages, and retry build again will be read from cached.
### 4/ Run project
```shell
$ yarn dev --scope @joktec/example-gateway
$ yarn dev --scope @joktec/example-micro
```
If conflict port, goto each package will have config.yml file. Edit port in it and re-run
```yaml
gateway:
port: 9010
micro:
port: 8010
```
P/S: This only affect on your local, don't impact to deployment
## 🗒️ Documentation
TBD
## 🙋 Contributing
Contributions to `@joktec/core` are welcome. If you would like to contribute, please fork the repository, make your changes, and submit a pull request.
Please make sure to update tests as appropriate.
## 🚨 Issues
If you encounter any issues while using all those libraries, please feel free to create an issue on our GitHub repository.
## ⭐ Like what we're doing? Give us a star
## License
All libraries is licensed under the MIT License.