|
| 1 | +# Multipart Uploads using Laravel, AWS S3, and Uppy |
| 2 | + |
| 3 | +[](https://packagist.org/packages/tapp network/laravel-uppy-s3-multipart-upload) |
| 4 | +[](https://github.com/tapp network/laravel-uppy-s3-multipart-upload/actions?query=workflow%3ATests+branch%3Amaster) |
| 5 | +[](https://packagist.org/packages/tapp network/laravel-uppy-s3-multipart-upload) |
| 6 | + |
| 7 | +This is where your description should go. Limit it to a paragraph or two. Consider adding a small example. |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +You can install the package via composer: |
| 12 | + |
| 13 | +```bash |
| 14 | +composer require tappnetwork/laravel-uppy-s3-multipart-upload |
| 15 | +``` |
| 16 | + |
| 17 | +You can publish the config file with: |
| 18 | +```bash |
| 19 | +php artisan vendor:publish --provider="TappNetwork\LaravelUppyS3MultipartUpload\LaravelUppyS3MultipartUploadServiceProvider" --tag="laravel-uppy-s3-multipart-upload-config" |
| 20 | +``` |
| 21 | + |
| 22 | +This is the contents of the published config file: |
| 23 | + |
| 24 | +```php |
| 25 | +return [ |
| 26 | +]; |
| 27 | +``` |
| 28 | + |
| 29 | +Disable CSRF on `s3/multipart` routes by adding this in your `app/Http/Middleware/VerifyCsrfToken.php`: |
| 30 | + |
| 31 | +```php |
| 32 | +protected $except = [ |
| 33 | + 's3/multipart*', |
| 34 | +]; |
| 35 | +``` |
| 36 | + |
| 37 | +Add these Uppy JS libraries on your `package.json` file: |
| 38 | + |
| 39 | +```json |
| 40 | + ... |
| 41 | + "dependencies": { |
| 42 | + "@uppy/aws-s3-multipart": "^1.8.12", |
| 43 | + "@uppy/core": "^1.16.0", |
| 44 | + "@uppy/drag-drop": "^1.4.24", |
| 45 | + "@uppy/status-bar": "^1.9.0", |
| 46 | + ... |
| 47 | + } |
| 48 | + ... |
| 49 | +``` |
| 50 | + |
| 51 | +Install the JS libraries: |
| 52 | + |
| 53 | +``` |
| 54 | +$ npm install |
| 55 | +$ npm run dev |
| 56 | +``` |
| 57 | + |
| 58 | +## Usage |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +## Testing |
| 63 | + |
| 64 | +```bash |
| 65 | +composer test |
| 66 | +``` |
| 67 | + |
| 68 | +## Changelog |
| 69 | + |
| 70 | +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. |
| 71 | + |
| 72 | +## Contributing |
| 73 | + |
| 74 | +Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. |
| 75 | + |
| 76 | +## Security Vulnerabilities |
| 77 | + |
| 78 | +Please review [our security policy](../../security/policy) on how to report security vulnerabilities. |
| 79 | + |
| 80 | +## Credits |
| 81 | + |
| 82 | +- [Tapp Network](https://github.com/TappNetwork) |
| 83 | +- [All Contributors](../../contributors) |
| 84 | + |
| 85 | +## License |
| 86 | + |
| 87 | +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. |
0 commit comments