Skip to content

Commit

Permalink
feat: Release initial stable version
Browse files Browse the repository at this point in the history
  • Loading branch information
dasundev committed Dec 30, 2023
0 parents commit 86aba8e
Show file tree
Hide file tree
Showing 30 changed files with 13,185 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/publish-npm-package.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Publish package to GitHub Packages
on:
release:
types: [published]
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v3
with:
node-version: '20.x'
registry-url: 'https://npm.pkg.github.com'
scope: '@dasundev'
- run: npm ci
working-directory: ./resources/js/livewire-dropzone-styles
- run: npm publish
working-directory: ./resources/js/livewire-dropzone-styles
env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
39 changes: 39 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Run Tests

on:
push:
branches:
- main
pull_request:
schedule:
- cron: '0 0 * * *'

jobs:
build-test:
runs-on: ubuntu-latest

strategy:
fail-fast: true
matrix:
php: [8.1, 8.2, 8.3]
laravel: [10]

name: Test PHP ${{ matrix.php }} with Laravel ${{ matrix.laravel }}

steps:
- uses: actions/checkout@v4

- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
ini-values: error_reporting=E_ALL
tools: composer:v2
coverage: none

- name: Install Dependencies
run: |
composer update --prefer-dist --no-interaction --no-progress --${{ matrix.stability }}
- name: Run Tests
run: composer run test
31 changes: 31 additions & 0 deletions .github/workflows/update-changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Update Changelog

on:
release:
types: [released]

jobs:
update:
runs-on: ubuntu-latest

permissions:
contents: write

steps:
- name: Checkout code
uses: actions/checkout@v4
with:
ref: main

- name: Update Changelog
uses: stefanzweifel/changelog-updater-action@v1
with:
latest-version: ${{ github.event.release.name }}
release-notes: ${{ github.event.release.body }}

- name: Commit updated CHANGELOG
uses: stefanzweifel/git-auto-commit-action@v5
with:
branch: main
commit_message: Update CHANGELOG
file_pattern: CHANGELOG.md
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/vendor
/node_modules
/.idea
.DS_Store
.phpunit.result.cache
13 changes: 13 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

# Navigate to the project directory

echo 'Run PHP code style fixer'
composer pint

echo 'Run code analyse with larastan'
composer analyse

echo 'Create an optimized production build'
npm run build
4 changes: 4 additions & 0 deletions .styleci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
preset: laravel

disabled:
- single_class_element_per_statement
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Changelog

This file records every version of `livewire-dropzone`.
55 changes: 55 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

## Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.

## Procedure

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

**Happy coding**!
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Dasun Tharanga

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<p align="center"><img src="./art/logo.svg" width="50%" alt="Livewire Dropzone"></p>

<p align="center"><img src="./art/dropzone.png" width="80%" alt="Livewire Dropzone"></p>

<p align="center">
<a href="https://github.com/dasundev/livewire-dropzone/actions"><img src="https://github.com/dasundev/livewire-dropzone/workflows/tests/badge.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/dasundev/livewire-dropzone"><img src="https://img.shields.io/packagist/dt/dasundev/livewire-dropzone" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/dasundev/livewire-dropzone"><img src="https://img.shields.io/packagist/v/dasundev/livewire-dropzone" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/dasundev/livewire-dropzone"><img src="https://img.shields.io/packagist/l/dasundev/livewire-dropzone" alt="License"></a>
</p>

## ✨ Introduction
This dropzone component for Livewire enables easy drag-and-drop file uploads.

> To use this package, you must have [Livewire 3](https://livewire.laravel.com/) installed.
## 📦 Installation
You can install the package via Composer:
```bash
composer require dasundev/livewire-dropzone
```

To install the styles package, use the following command:
```bash
npm i @dasundev/livewire-dropzone-styles
```

Import styles to your project
```scss
// resources/css/app.css

@import "@dasundev/livewire-dropzone-styles";
```

## 🎬 Showcase
Now you can use the dropzone component as you like.
```html
<livewire:dropzone
wire:model="banners"
:rules="['image','mimes:png,jpeg','max:10420']"
:multiple="true" />
```

## 🎨 Tailor UI
The dropzone component is entirely customizable. Just publish the view file and make it your own.
```bash
php artisan vendor:publish --tag=livewire-dropzone-views
```

## 📌 Special Note
The Livewire dropzone component uploads files to Livewire's [temporary upload directory](https://livewire.laravel.com/docs/uploads#temporary-upload-directory). To permanently store them, manual action is required. This is where `wire:model` becomes essential. For example, take the `banners` model, which contains each upload as an array containing file paths. You can iterate through this array and store the files according to your preferences.

## 📝 Blog Post
I made a blog post about using the Livewire dropzone to store files permanently. It's perfect for people new to Laravel. You can read the blog post [here](https://www.dasun.dev/blog/how-to-use-livewire-dropzone).
Binary file added art/dropzone.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions art/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
58 changes: 58 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{
"name": "dasundev/livewire-dropzone",
"description": "A dropzone component for Livewire enables easy drag-and-drop file uploads.",
"keywords": [
"livewire",
"dropzone"
],
"license": "MIT",
"authors": [
{
"name": "Dasun Tharanga",
"email": "[email protected]",
"role": "Developer"
}
],
"require": {
"php": "^8.1",
"livewire/livewire": "^3.0",
"spatie/laravel-package-tools": "^1.16"
},
"require-dev": {
"larastan/larastan": "^2.0",
"laravel/pint": "^1.13",
"orchestra/testbench": "^8.0",
"pestphp/pest": "^1.23"
},
"autoload": {
"psr-4": {
"Dasundev\\LivewireDropzone\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Dasundev\\LivewireDropzone\\Tests\\": "tests"
}
},
"scripts": {
"test": "vendor/bin/pest",
"pint": "vendor/bin/pint --dirty",
"analyse": "vendor/bin/phpstan analyse"
},
"config": {
"sort-packages": true,
"allow-plugins": {
"pestphp/pest-plugin": true
}
},
"extra": {
"laravel": {
"providers": [
"Dasundev\\LivewireDropzone\\LivewireDropzoneServiceProvider"
],
"aliases": {
"LivewireDropzone": "Dasundev\\LivewireDropzone\\LivewireDropzoneFacade"
}
}
}
}
Loading

0 comments on commit 86aba8e

Please sign in to comment.