{"id":18535048,"url":"https://github.com/tranbavinhson/microservice_nodejs_template","last_synced_at":"2025-10-13T21:39:15.908Z","repository":{"id":36526184,"uuid":"224976519","full_name":"TranBaVinhSon/microservice_nodejs_template","owner":"TranBaVinhSon","description":"🦄 Microservice Starter Kit by Nodejs + Typescript + Docker + Lerna + Eslint + Prettier","archived":false,"fork":false,"pushed_at":"2022-12-11T15:30:53.000Z","size":830,"stargazers_count":56,"open_issues_count":60,"forks_count":14,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T09:53:55.111Z","etag":null,"topics":["docker","docker-compose","eslint","lerna","lerna-kit","lerna-monorepo","lerna-starter","lernajs","microservice","microservices-architecture","nodejs","prettier","prettier-eslint","typescript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TranBaVinhSon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-30T07:33:40.000Z","updated_at":"2025-03-23T07:47:55.000Z","dependencies_parsed_at":"2023-01-17T02:30:39.495Z","dependency_job_id":null,"html_url":"https://github.com/TranBaVinhSon/microservice_nodejs_template","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/TranBaVinhSon/microservice_nodejs_template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TranBaVinhSon%2Fmicroservice_nodejs_template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TranBaVinhSon%2Fmicroservice_nodejs_template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TranBaVinhSon%2Fmicroservice_nodejs_template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TranBaVinhSon%2Fmicroservice_nodejs_template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TranBaVinhSon","download_url":"https://codeload.github.com/TranBaVinhSon/microservice_nodejs_template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TranBaVinhSon%2Fmicroservice_nodejs_template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017049,"owners_count":26085951,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-13T02:00:06.723Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","eslint","lerna","lerna-kit","lerna-monorepo","lerna-starter","lernajs","microservice","microservices-architecture","nodejs","prettier","prettier-eslint","typescript"],"created_at":"2024-11-06T19:18:57.142Z","updated_at":"2025-10-13T21:39:15.876Z","avatar_url":"https://github.com/TranBaVinhSon.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eMicroservice Nodejs Template\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/prettier/prettier\"\u003e\n    \u003cimg\n      src=\"https://img.shields.io/badge/code_style-prettier-ff69b4.svg\"\n      alt=\"Prettier\"\n    /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://lerna.js.org/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg\" alt=\"Lerna\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"\" target=\"_blank\"\u003e\n    \u003cimg alt=\"Documentation\" src=\"https://img.shields.io/badge/documentation-yes-brightgreen.svg\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"\" target=\"_blank\"\u003e\n    \u003cimg alt=\"License: MIT\" src=\"https://img.shields.io/github/license/dotrungkien/2048\" /\u003e\n  \u003cbr\u003e\n\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003e\nLerna + Docker + Typescript + EsLint + Prettier\n\u003c/h4\u003e\n\n# Table of Contents\n\n- [Introduction](#introduction)\n- [Techstack](#techstack)\n- [Install](#install)\n- [Usage](#usage)\n- [Project Structure](#project-structure)\n  - [api_gateway container](#api_gateway-container)\n  - [backend container](#backend-container)\n- [Contributing](#contributing)\n\n## Introduction\n\n\u003e The simple project shows how to setup monorepo by Typescript + Docker + Lerna + Eslinter + Prettier.\n\nThe project has 3 packages (inside [packages directory](https://github.com/TranBaVinhSon/microservice_nodejs_template/tree/master/packages))\n\n- api_gateway (http server)\n- backend (http server)\n- base (shared package between `api_gateway` and `backend`)\n\n_Note: Each package has its own eslint, tsconfig, preitter config._\n\n## Techstack\n\n- [Lerna](https://github.com/lerna/lerna) - A tool for managing JavaScript projects with multiple packages\n- [TsED](https://tsed.io/) - A TypeScript Framework on top of Express\n- Docker\n- Eslint + Prettier\n\n## Install\n\n```sh\nmake install-all\n```\n\nThat's it 🚀\n\n## Usage\n\nGo to root project: `cd microservice_nodejs_template`\n\n### Running project\n\n```sh\ndocker-compose up\n```\n\nThat's it 🚀\n\nAfter run `docker-compose up`, you will see `api_gateway` container runs on `3000` port. and `backend` container runs on `8000` port.\n\n(you can also check the api by make a request to `GET localhost:3000/api/v1/users/`)\n\n![Screen Shot 2019-12-07 at 4 14 47 PM](https://user-images.githubusercontent.com/12994069/70370632-c5f9b600-190c-11ea-9e7b-9ca501a03e0a.png)\n\n### Compile ts to js\n\n- Compile all packages\n\n```\nnpm run build\n```\n\n- Compile `api_gateway` package\n\n```\nnpm run build:api_gateway\n```\n\n- Compile `backend` package\n\n```\nnpm run build:backend\n```\n\n- Compile `base` package\n\n```\nnpm run build:base\n```\n\n### Running Eslint\n\n- Running Eslint on all packages\n\n```\nnpm run eslint\n```\n\n## Project Structure\n\nEach package under the `packages` folder.\n\n```\nmicroservice_nodejs_template\n├── docker/\n│   ├── api_gateway/\n│   │   └── Dockerfile\n│   ├── backend/\n│   │   └── Dockerfile\n├── packages/\n│   ├── api_gateway/\n│   │   └── src/\n│   │   ├── package.json\n│   │   ├── tsconfig.json\n│   │\n│   ├── backend/\n│   │   └── src/\n│   │   └── package.json\n│   │   ├── tsconfig.json\n│   │\n│   ├── base/\n│   │   └── src/\n│   │   └── package.json\n│   │   ├── tsconfig.json\n│\n├── docker-compose.yml\n├── package.json\n├── lerna.json\n├── README.md\n```\n\n### `api_gateway container` structure\n\n```\nmicroservice_nodejs_template\n├── packages/\n│   ├── api_gateway/\n│   │   └── src/\n│   │   ├── package.json\n│   │   ├── tsconfig.json\n│   │\n│   ├── base/\n│   │   └── src/\n│   │   └── package.json\n│   │   ├── tsconfig.json\n│\n│\n├── package.json\n├── lerna.json\n```\n\n### `backend container` structure\n\n```\nmicroservice_nodejs_template\n├── packages/\n│   ├── backend/\n│   │   └── src/\n│   │   ├── package.json\n│   │   ├── tsconfig.json\n│   │\n│   ├── base/\n│   │   └── src/\n│   │   └── package.json\n│   │   ├── tsconfig.json\n│\n│\n├── package.json\n├── lerna.json\n```\n\n## Contributing\n\nContributions, issues and feature requests are welcome.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftranbavinhson%2Fmicroservice_nodejs_template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftranbavinhson%2Fmicroservice_nodejs_template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftranbavinhson%2Fmicroservice_nodejs_template/lists"}