{"id":24997945,"url":"https://github.com/quang-pham-dev/event-stream-api","last_synced_at":"2026-04-11T19:02:46.529Z","repository":{"id":275558872,"uuid":"926320378","full_name":"quang-pham-dev/event-stream-api","owner":"quang-pham-dev","description":"[WIP] event stream api","archived":false,"fork":false,"pushed_at":"2025-02-03T09:16:53.000Z","size":108,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-03T10:25:16.197Z","etag":null,"topics":["aws","nestjs","nodejs","rest-api","s3"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/quang-pham-dev.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-03T03:06:23.000Z","updated_at":"2025-02-03T09:16:53.000Z","dependencies_parsed_at":"2025-02-03T10:25:32.752Z","dependency_job_id":"63c95c5f-d20c-42ad-837d-4da0a4b21a1d","html_url":"https://github.com/quang-pham-dev/event-stream-api","commit_stats":null,"previous_names":["quang-pham-dev/event-stream-api"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quang-pham-dev%2Fevent-stream-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quang-pham-dev%2Fevent-stream-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quang-pham-dev%2Fevent-stream-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quang-pham-dev%2Fevent-stream-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quang-pham-dev","download_url":"https://codeload.github.com/quang-pham-dev/event-stream-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246209995,"owners_count":20741095,"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":["aws","nestjs","nodejs","rest-api","s3"],"created_at":"2025-02-04T17:26:45.151Z","updated_at":"2025-12-30T20:29:47.135Z","avatar_url":"https://github.com/quang-pham-dev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EVENT-STREAM-API\n\n## Table of Contents\n\n- [EVENT-STREAM-API](#event-stream-api)\n  - [Table of Contents](#table-of-contents)\n  - [Getting Started - Local Development](#getting-started---local-development)\n    - [Prerequisites](#prerequisites)\n    - [Installation](#installation)\n  - [Available Scripts](#available-scripts)\n    - [`pnpm run start:dev`](#pnpm-run-startdev)\n    - [`pnpm run test`](#pnpm-run-test)\n    - [`pnpm run build`](#pnpm-run-build)\n    - [`pnpm run start:prod`](#pnpm-run-startprod)\n  - [Features](#features)\n  - [Environment Variables](#environment-variables)\n  - [AWS Integration](#aws-integration)\n\n## Getting Started - Local Development\n\n### Prerequisites\n\nMake sure you have the following installed on your system:\n\n- Node.js (v20 or later recommended)\n- pnpm (comes with Node.js)\n- AWS Account (for S3 and CloudFront features)\n\n### Installation\n\n1. Clone the repository\n2. Install dependencies:\n   ```bash\n   pnpm install\n   ```\n3. Copy the example environment file and configure your variables:\n   ```bash\n   cp .env.example .env\n   ```\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `pnpm run start:dev`\n\nRuns the app in development mode with watch mode enabled.\nThe application will automatically reload if you change any of the source files.\n\n### `pnpm run test`\n\nLaunches the test runner.\nAdditional test scripts:\n\n- `pnpm run test:watch` - Run tests in watch mode\n- `pnpm run test:cov` - Generate test coverage report\n- `pnpm run test:e2e` - Run end-to-end tests\n\n### `pnpm run build`\n\nBuilds the app for production to the `dist` folder.\nUses the NestJS CLI to create an optimized production build.\n\n### `pnpm run start:prod`\n\nRuns the built application in production mode.\nMake sure to run `pnpm run build` before using this command.\n\n## Features\n\n- AWS S3 Integration for file storage\n- AWS CloudFront CDN support\n- File upload handling with Multer\n- Image processing with Sharp\n- Rate limiting\n- Security features with Helmet\n- Compression for response optimization\n- Cookie parsing\n- Request IP tracking\n- Swagger API documentation\n\n## Environment Variables\n\n| Variable Name              | Description                      | Required |\n| -------------------------- | -------------------------------- | -------- |\n| AWS_REGION                 | AWS Region for S3 and CloudFront | Yes      |\n| AWS_ACCESS_KEY_ID          | AWS Access Key                   | Yes      |\n| AWS_SECRET_ACCESS_KEY      | AWS Secret Access Key            | Yes      |\n| S3_BUCKET_NAME             | Name of the S3 bucket            | Yes      |\n| CLOUDFRONT_DISTRIBUTION_ID | CloudFront Distribution ID       | Yes      |\n| PORT                       | Server port (default: 3000)      | No       |\n\n## AWS Integration\n\nThis project uses several AWS services:\n\n- **S3**: For file storage\n- **CloudFront**: As CDN for file distribution\n- **AWS SDK v3**: Latest version of AWS SDK for JavaScript\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquang-pham-dev%2Fevent-stream-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquang-pham-dev%2Fevent-stream-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquang-pham-dev%2Fevent-stream-api/lists"}