{"id":25281935,"url":"https://github.com/pnstack/nestjs-storage-service","last_synced_at":"2025-04-06T13:13:29.727Z","repository":{"id":193570412,"uuid":"689061981","full_name":"pnstack/nestjs-storage-service","owner":"pnstack","description":"NestJS Storage Service build with nestjs ❤️ s3","archived":false,"fork":false,"pushed_at":"2025-01-22T09:17:30.000Z","size":497,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-12T19:08:55.009Z","etag":null,"topics":[],"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/pnstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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},"funding":{"github":["nvp2k1"]}},"created_at":"2023-09-08T17:51:12.000Z","updated_at":"2024-09-21T14:46:34.000Z","dependencies_parsed_at":null,"dependency_job_id":"dffa8ad9-c2f0-41bd-be81-749d239b3ff0","html_url":"https://github.com/pnstack/nestjs-storage-service","commit_stats":null,"previous_names":["pnstack/nestjs-storage-service"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnstack%2Fnestjs-storage-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnstack%2Fnestjs-storage-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnstack%2Fnestjs-storage-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pnstack%2Fnestjs-storage-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pnstack","download_url":"https://codeload.github.com/pnstack/nestjs-storage-service/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247485290,"owners_count":20946398,"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":[],"created_at":"2025-02-12T19:08:57.428Z","updated_at":"2025-04-06T13:13:29.721Z","avatar_url":"https://github.com/pnstack.png","language":"TypeScript","funding_links":["https://github.com/sponsors/nvp2k1"],"categories":[],"sub_categories":[],"readme":"# NestJS Storage Service\n\nA robust storage service built with NestJS for handling file uploads and storage management with AWS S3 integration.\n\n## Features\n\n- 📁 File storage management\n- 🚀 AWS S3 integration for cloud storage\n- 📤 File upload handling\n- 🔐 Secure file access management\n- 📝 Swagger API documentation\n- 🔄 GraphQL support\n- 📊 Bull queue for background jobs\n- 🗄️ Redis caching integration\n\n## Prerequisites\n\n- Node.js (check `.nvmrc` for version)\n- pnpm\n- Redis (for caching and queues)\n- AWS S3 credentials (for cloud storage)\n\n## Installation\n\n```bash\n# Install dependencies\npnpm install\n```\n\n## Environment Configuration\n\nCopy the example environment file and update it with your configuration:\n\n```bash\ncp .env.example .env\n```\n\nRequired environment variables:\n\n- `AWS_ACCESS_KEY_ID`: AWS access key\n- `AWS_SECRET_ACCESS_KEY`: AWS secret key\n- `AWS_REGION`: AWS region\n- `AWS_BUCKET`: S3 bucket name\n- `REDIS_URL`: Redis connection URL\n\n## Development\n\n```bash\n# Start development server\npnpm dev\n\n# Run tests\npnpm test\n\n# Run e2e tests\npnpm test:e2e\n\n# Generate API documentation\npnpm compodoc\n```\n\n## Production\n\n```bash\n# Build the application\npnpm build\n\n# Start production server\npnpm start:prod\n```\n\n## Docker Support\n\nBuild and run the service using Docker:\n\n```bash\n# Build Docker image\ndocker build -t nestjs-storage-service .\n\n# Run container\ndocker-compose up -d\n```\n\n## API Documentation\n\n- Swagger UI: `http://localhost:3000/api/docs`\n- Compodoc: `http://localhost:8080` (after running `pnpm compodoc`)\n\n## Contributing\n\n1. Fork the repository\n2. Create a new branch\n3. Make your changes\n4. Submit a pull request\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Authors\n\n- npv2k1\n\n## Support\n\nFor support, please open an issue in the GitHub repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpnstack%2Fnestjs-storage-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpnstack%2Fnestjs-storage-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpnstack%2Fnestjs-storage-service/lists"}