Refactor Added workflow

Mishhub · Mishhub · commit f399c4b4962b · 2025-04-04T10:59:51.000+04:00
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '[BUG] '
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Code example**
+```typescript
+// Your code here
+```
+
+**Environment:**
+ - Node.js version: [e.g. 20.15.0]
+ - NestJS version: [e.g. 11.0.0]
+ - MinIO version: [e.g. 8.0.5]
+ - Package version: [e.g. 1.0.11]
+
+**Additional context**
+Add any other context about the problem here. 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '[FEATURE] '
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here. 
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+        
+    - name: Install dependencies
+      run: npm ci
+      
+    - name: Run linting
+      run: npm run lint
+      
+    - name: Run tests
+      run: npm run test
+      
+    - name: Build
+      run: npm run build
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,43 @@
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior:
+
+* The use of sexualized language or imagery, and sexual attention or advances
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information without explicit permission
+* Other conduct which could reasonably be considered inappropriate
+
+## Enforcement
+
+Violations of the Code of Conduct may be reported to the project team at
+[INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html 
diff --git a/README.md b/README.md
@@ -1,7 +1,25 @@
 # NestJS MinIO Backend
 
+[![NPM Version][npm-image]][npm-url]
+[![Downloads Stats][npm-downloads]][npm-url]
+[![License][license-image]][license-url]
+[![TypeScript][typescript-image]][typescript-url]
+[![NestJS][nestjs-image]][nestjs-url]
+[![MinIO][minio-image]][minio-url]
+
 A powerful and flexible NestJS module for integrating MinIO object storage into your NestJS applications. This package provides a seamless way to interact with MinIO, an open-source object storage service compatible with Amazon S3.
 
+## Table of Contents
+- [Features](#features)
+- [Installation](#installation)
+- [Requirements](#requirements)
+- [Quick Start](#quick-start-using-decorators)
+- [Configuration](#configuration)
+- [API Reference](#api-reference)
+- [Contributing](#contributing)
+- [License](#license)
+- [Support](#support)
+
 ## Features
 
 - 🚀 Easy integration with NestJS applications
@@ -320,19 +338,52 @@ async downloadFile(@Param('objectName') objectName: string, @Res() res: Response
 
 ## API Reference
 
-### MinioService Methods
+### Decorators
+
+#### @FileUpload()
+Handles file uploads with automatic MinIO integration.
+
+```typescript
+@FileUpload([
+  { 
+    name: string,           // Field name in the request
+    bucketName: string,     // MinIO bucket name
+    required?: boolean,     // Whether the file is required
+    maxCount?: number,      // Maximum number of files
+    maxSize?: number,       // Maximum file size in bytes
+    mimeTypes?: string[]    // Allowed MIME types
+  }
+])
+```
 
-- `upload(bucketName: string, objectName: string, file: Buffer): Promise<void>`
-- `download(bucketName: string, objectName: string): Promise<Buffer>`
-- `delete(bucketName: string, objectName: string): Promise<void>`
-- `getSignedUrl(bucketName: string, objectName: string, expiryInSeconds: number): Promise<string>`
-- And more...
+#### @FileField()
+Swagger-ready DTO field decorator for file uploads.
 
-For detailed API documentation, please refer to the source code and included TypeScript definitions.
+```typescript
+@FileField({
+  bucketName: string,       // MinIO bucket name
+  required?: boolean,       // Whether the field is required
+  description?: string      // Swagger description
+})
+```
+
+#### @FileSchemaField()
+Mongoose schema integration for file fields.
+
+```typescript
+@FileSchemaField({
+  bucketName: string,       // MinIO bucket name
+  required?: boolean        // Whether the field is required
+})
+```
 
 ## Contributing
 
-Contributions are welcome! Please feel free to submit a Pull Request.
+1. Fork it ([https://github.com/UtilKit/nestjs-minio-backend/fork](https://github.com/UtilKit/nestjs-minio-backend/fork))
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -am 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Create a new Pull Request
 
 ## License
 
@@ -344,4 +395,18 @@ Mishhub
 
 ## Support
 
-If you encounter any issues or have questions, please file an issue on the GitHub repository. 
+- 📫 [GitHub Issues](https://github.com/UtilKit/nestjs-minio-backend/issues)
+- 💬 [Discord Community](https://discord.gg/your-community)
+- 📧 Email: support@example.com
+
+[npm-image]: https://img.shields.io/npm/v/nestjs-minio-backend.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/nestjs-minio-backend
+[npm-downloads]: https://img.shields.io/npm/dm/nestjs-minio-backend.svg?style=flat-square
+[license-image]: https://img.shields.io/npm/l/nestjs-minio-backend.svg?style=flat-square
+[license-url]: LICENSE
+[typescript-image]: https://img.shields.io/badge/TypeScript-Ready-blue.svg?style=flat-square
+[typescript-url]: https://www.typescriptlang.org/
+[nestjs-image]: https://img.shields.io/badge/NestJS-Compatible-red.svg?style=flat-square
+[nestjs-url]: https://nestjs.com/
+[minio-image]: https://img.shields.io/badge/MinIO-Compatible-green.svg?style=flat-square
+[minio-url]: https://min.io/ 
diff --git a/package.json b/package.json
@@ -14,6 +14,17 @@
   "homepage": "https://github.com/UtilKit/nestjs-minio-backend#readme",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
   "files": [
     "dist",
     "README.md",
@@ -24,7 +35,15 @@
     "minio",
     "s3",
     "object-storage",
-    "backend"
+    "backend",
+    "file-upload",
+    "storage",
+    "cloud-storage",
+    "file-management",
+    "typescript",
+    "decorators",
+    "swagger",
+    "mongoose"
   ],
   "engines": {
     "node": ">=20.15.0"
