-
-
Notifications
You must be signed in to change notification settings - Fork 222
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
220 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: Create a report to help us improve | ||
labels: bug | ||
assignees: luanfreitasdev | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
|
||
* .. | ||
|
||
**To Reproduce** | ||
* Got to .. | ||
|
||
**Laravel version (exactly):** | ||
* 8.x.x ? | ||
|
||
**Alpine version:** | ||
* 3.x.x ? | ||
|
||
**Theme:** | ||
- [ ] Tailwind | ||
- Version: | ||
|
||
- [ ] Bootstrap | ||
- Version: | ||
|
||
**Screenshots** (***This helps to understand better***) | ||
|
||
|
||
|
||
**Do you have any idea how we can fix it?** |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
<div align="center"> | ||
<p><img src="art/header.jpg" alt="PowerGrid Logo"></p> | ||
</div> | ||
|
||
------ | ||
|
||
# How to contribute with PowerGrid | ||
|
||
This article's objective is to facilitate the process of collaborating with [PowerGrid](https://github.com/Power-Components/livewire-powergrid). | ||
|
||
## 1) Fork the project | ||
To fork PowerGrid, you simply have to access the repository's page [PowerGrid](https://github.com/Power-Components/livewire-powergrid) and click *Fork*:<br /> | ||
<img src="https://raw.githubusercontent.com/Power-Components/como-contribuir-com-o-powergrid/main/img/click-to-fork.png" /><br /> | ||
As a result, you should have something similar to https://github.com/cpereiraweb/livewire-powergrid.<br /> | ||
Note: If you are a member of different teams or organizations, you must select which account you will be forking to. | ||
|
||
## 2) Clone your fork repository to your computer | ||
Select or create a new folder at your computer where you want to store project files:<br /> | ||
<img src="https://github.com/Power-Components/como-contribuir-com-o-powergrid/blob/main/img/cloning-repo.png?raw=true"> | ||
|
||
## 3) Create a new branch and push it to your repository | ||
Access the repository's folder: | ||
```bash | ||
cd livewire-powergrid | ||
``` | ||
Create a new branch (For instance, my own name as the branch name): | ||
```bash | ||
git checkout -b cpereiraweb | ||
``` | ||
You need to push this branch to the server. As a suggestion, create a TODO.md file at the project's root. Add it and commit. | ||
```bash | ||
touch TODO.md | ||
git add . | ||
git commit -m "Added TODO.md" | ||
git push origin cpereiraweb # Use your branch name here, ok? | ||
``` | ||
## 4) Add PowerGrid to your Laravel project | ||
Open your Laravel's project and install the component as described in its documentation. | ||
```bash | ||
composer require power-components/livewire-powergrid | ||
``` | ||
## 5) Configure ```composer``` to use your own PowerGrid clone | ||
You will need to inform `composer` that you want to use a developing version of this package and where is this version located. | ||
This is very simple to do: | ||
Open composer.json file and locate the PowerGrid requirement line: | ||
```json | ||
"power-components/livewire-powergrid": "^1.0", | ||
``` | ||
Following what I have done so far, I will configure the version which must be `dev-`+`your-branch-name`. Following our example: `dev-cpereiraweb`: | ||
```json | ||
"power-components/livewire-powergrid": "dev-cpereiraweb", | ||
``` | ||
The second step is to inform where is the repository located. To do so, we add the section `repositories` to the `composer.json` file. | ||
In this section you can inform either your Github repository URL or indicate its path on your local machine. | ||
|
||
The example below uses the GitHub repository URL: | ||
```json | ||
... | ||
"spatie/laravel-ray": "^1.17", | ||
"wulfheart/pretty_routes": "^0.2.0" | ||
}, | ||
"repositories": [ | ||
{ | ||
"type": "vcs", | ||
"url": "https://github.com/cpereiraweb/livewire-powergrid.git" | ||
} | ||
], | ||
"autoload": { | ||
... | ||
``` | ||
|
||
And, the next example shows the version with your local path: | ||
```json | ||
... | ||
"spatie/laravel-ray": "^1.17", | ||
"wulfheart/pretty_routes": "^0.2.0" | ||
}, | ||
"repositories": [ | ||
{ | ||
"type": "path", | ||
"url": "Z:\\Code\\forks\\PowerComponents\\livewire-powergrid" | ||
} | ||
], | ||
"autoload": { | ||
... | ||
``` | ||
|
||
Note: The example above shows a Windows OS path. If you are a `WSL`, `Docker`, `Linux` or `MacOS` user, you must adapt this path to your system's format. | ||
For example: `/home/cpereiraweb/code/forks/PowerComponents/livewire-powergrid`. | ||
|
||
## 6) Run `composer update` command | ||
Now, just run `composer update` command inside your Laravel project so composer can update its references. See below the result using the repository link:<br /> | ||
|
||
<img src="https://github.com/Power-Components/como-contribuir-com-o-powergrid/blob/main/img/composer-update.png?raw=true"><br /> | ||
The image shows the commits at my repository. First, I had installed the commit `219cdd8`. Now, at the image above you can see that it has been updated to the commit `65ae610`. | ||
|
||
If you had your `composer.json` configured to use a local path instead, you should have a result similar to this:<br/> | ||
<img src="https://github.com/Power-Components/como-contribuir-com-o-powergrid/blob/main/img/composer-update-local-repo.png?raw=true"><br /> <br /> | ||
|
||
You may notice that the GitHub's version was removed and it was replaced by the local version. The commit indications are no longer displayed. With this configuration, I am not required to `push` my fork nor run `composer update` in my Laravel Project. It is a more dynamic process. | ||
|
||
## It's all set! | ||
Now, just follow the regular flow of any Git project. Perform any changes to your own fork and push to Github. | ||
Always run `composer update` inside your Laravel project to update the codes used in your project. | ||
That's it. Clean procedure and no MOP*. | ||
|
||
\*(*[MacGyver](https://www.lexico.com/definition/macgyver)-oriented Programming*) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 Power Components ⚡ | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
<?php | ||
|
||
return [ | ||
'buttons' => [ | ||
'filter' => 'Filtre', | ||
], | ||
'labels' => [ | ||
'action' => 'İşlemler', | ||
'results_per_page' => 'Sayfa başına veri', | ||
'clear_filter' => 'Filtreleri temizle', | ||
'no_data' => 'Veri bulunamadı', | ||
'all' => 'Tümü', | ||
'selected' => 'Seçili', | ||
], | ||
'placeholders' => [ | ||
'search' => 'Arama yap...', | ||
'select' => 'Dönem seç', | ||
], | ||
'pagination' => [ | ||
'showing' => 'Gösterilen:', | ||
'to' => 'ile', | ||
'of' => 'arası. Toplam:', | ||
'results' => 'Sonuç', | ||
'all' => 'Tümü', | ||
], | ||
'multi_select' => [ | ||
'select' => 'Seç', | ||
'all' => 'Tümü', | ||
], | ||
'select' => [ | ||
'select' => 'Seç', | ||
'all' => 'Tümü', | ||
], | ||
'boolean_filter' => [ | ||
'all' => 'Tümü', | ||
], | ||
'input_text_options' => [ | ||
'is' => 'Eşit', | ||
'is_not' => 'Eşit olmayan', | ||
'contains' => 'İçeren', | ||
'contains_not' => 'İçermeyen', | ||
'starts_with' => 'Başlayan', | ||
'ends_with' => 'Biten', | ||
], | ||
]; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters