{"id":18963410,"url":"https://github.com/pashamakhilkumarreddy/nestjs-microservices","last_synced_at":"2026-04-09T11:07:35.919Z","repository":{"id":38248089,"uuid":"270366737","full_name":"pashamakhilkumarreddy/nestjs-microservices","owner":"pashamakhilkumarreddy","description":"This is a RESTful API built using Nx/Nest.JS, a framework for building efficient, scalable Node.js server-side applications. This application also utilizes Docker for containerization, NVM for managing Node.js versions, and Swagger for API documentation and testing.","archived":false,"fork":false,"pushed_at":"2024-08-31T05:59:59.000Z","size":504,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-01T05:20:59.674Z","etag":null,"topics":["docker","docker-compose","javascript","kafka","microservices","nestjs","nestjs-backend","swagger","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pashamakhilkumarreddy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-07T16:35:04.000Z","updated_at":"2024-06-12T17:49:55.000Z","dependencies_parsed_at":"2024-06-12T22:15:56.525Z","dependency_job_id":"6918a877-8ad1-4ebe-a7d1-97d3ecad2904","html_url":"https://github.com/pashamakhilkumarreddy/nestjs-microservices","commit_stats":null,"previous_names":["pashamakhilkumarreddy/nestjs-microservices"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fnestjs-microservices","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fnestjs-microservices/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fnestjs-microservices/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pashamakhilkumarreddy%2Fnestjs-microservices/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pashamakhilkumarreddy","download_url":"https://codeload.github.com/pashamakhilkumarreddy/nestjs-microservices/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239958307,"owners_count":19724926,"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","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","javascript","kafka","microservices","nestjs","nestjs-backend","swagger","typescript"],"created_at":"2024-11-08T14:19:16.727Z","updated_at":"2025-12-30T22:40:23.562Z","avatar_url":"https://github.com/pashamakhilkumarreddy.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nest.JS Microservices\n\nThis is a RESTful API built using Nest.js, a framework for building efficient, scalable Node.js server-side applications. This application also utilizes Docker for containerization, NVM for managing Node.js versions, and Swagger for API documentation and testing.\n\n## Prerequisites\n\n-   Node.js version 20.x.x (LTS)\n-   Postgres\n-   Docker\n-   Docker Compose\n-   NVM (optional, for managing Node.js versions)\n\n## Table of Contents\n\n-   [Installation](#installation)\n-   [Usage](#usage)\n-   [Swagger](#swagger)\n-   [Docker](#docker)\n-   [Testing](#testing)\n-   [Linting and Formatting](#linting-and-formatting)\n-   [Contributing](#contributing)\n\n## Installation\n\nBefore you begin, ensure you have [Node.js](https://nodejs.org/) installed, and consider using [NVM](https://github.com/nvm-sh/nvm) to manage your Node.js versions. The project uses Node.js version specified in `.nvmrc`.\n\n1. Clone this repository:\n\n```bash\ngit clone https://github.com/pashamakhilkumarreddy/nestjs-microservices.git\n```\n\n2. Change to the project directory:\n\n```bash\ncd nestjs-microservices\n```\n\n3. If using NVM, run the following command to ensure the correct Node.js version is used:\n\n```bash\nnvm use\n```\n\n4. Create a .env file in the project root directory and add the required environment variables (see .env.example as a reference).\n\n```bash\ncp .env.example .env\n```\n\n5. Install dependencies using npm:\n\n```bash\nnpm install\n```\n\n## Usage\n\nStart the application:\n\n```bash\nnpm run start\n```\n\n```bash\nnpm run start:auth\n```\n\n```bash\nnpm run start:payments\n```\n\n## Swagger\n\nAccess Swagger UI at [Swagger API Docs](http://localhost:5000/api-docs)\n\n## Docker\n\nThis project includes Docker Compose files for production, development, and QA environments. Before using Docker, make sure you have the required environment variables set in the corresponding .env files (see .env.example as a reference).\n\n#### Running Docker Containers\n\nTo run Docker containers use the following commands:\n\n```bash\nnpm run docker:start\n```\n\n#### Stopping and Cleaning Docker Containers\n\nTo stop and clean Docker containers, use the following commands:\n\n```bash\nnpm run docker:stop\nnpm run docker:clean\n```\n\n## Testing\n\n1. Run Tests\n\n```bash\nnpm test\n```\n\n2. Watch Tests\n\n```bash\nnpm run test:watch\n```\n\n3. Test Coverage\n\n```bash\nnpm run test:coverage\n```\n\n4. Debug Tests\n\n```bash\nnpm run test:debug\n```\n\n5. End-to-End Tests\n\n```bash\nnpm run test:e2e\n```\n\n## Linting and Formatting\n\n1. Run ESLint\n\n```bash\nnpm run lint\n```\n\n2. Fix ESLint Issues\n\n```bash\nnpm run lint:fix\n```\n\n3. Format Code\n\n```bash\nnpm run format:fix\n```\n\n#### Pre-commit Hook\n\nLinting and formatting are enforced through the pre-commit hook using Husky and lint-staged. Make sure to address any issues reported by the hook. If you want to temporarily disable pre-commit hooks, you can use the `--no-verify` or `-n` option with your Git commit command. This option skips the pre-commit and commit-msg hooks for that specific commit.\n\n```bash\ngit commit --no-verify -m \"Your commit message\"\n```\n\n## Contributing\n\n[See the guide in Contributing.](./CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpashamakhilkumarreddy%2Fnestjs-microservices","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpashamakhilkumarreddy%2Fnestjs-microservices","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpashamakhilkumarreddy%2Fnestjs-microservices/lists"}