-
Notifications
You must be signed in to change notification settings - Fork 17
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
1 changed file
with
72 additions
and
2 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 |
---|---|---|
@@ -1,2 +1,72 @@ | ||
# larasupport | ||
Adds missing helpers and other support that are not being made to the core of Lumen. Adds support to use Laravel Packages with Lumen. | ||
Larasupport Package | ||
==================== | ||
|
||
[](https://github.com/irazasyed/larasupport) | ||
[](https://github.com/irazasyed/larasupport/releases) | ||
[](LICENSE) | ||
[](https://packagist.org/packages/irazasyed/larasupport) | ||
|
||
|
||
> Laravel Support for Lumen: Adds missing helpers that are not being made to the core of Lumen. Lets you use Laravel Packages in Lumen. | ||
> | ||
> There are some helper functions that are available in core of Laravel framework which are being used in Laravel Packages. Now because of these helpers missing in core of the Lumen, You won't be able to use those amazing Laravel Packages. | ||
> | ||
> I had submited PRs as well as created issue tickets in Lumen to add these helpers to the core but it got rejected with a reason to use Laravel instead. Just for Packages support i didn't want to use full-stack framework. There were few discussions about the same as well. Hence, This package to deal with this issue! | ||
## Quick Start | ||
|
||
|
||
### Installation | ||
|
||
#### Install Through Composer | ||
|
||
You can either add the package directly by firing this command | ||
|
||
``` | ||
$ composer require irazasyed/larasupport:~1.0 | ||
``` | ||
|
||
Or add in the `require` key of `composer.json` file manually | ||
|
||
``` | ||
"irazasyed/larasupport": "~1.0" | ||
``` | ||
|
||
And Run the Composer update command | ||
|
||
``` | ||
$ composer update | ||
``` | ||
|
||
And you're done! You can now start installing any Laravel Package out there. | ||
|
||
## Available Methods | ||
> These helpers can be used across your Lumen project, not only with Laravel Packages. | ||
#### public_path | ||
Get the fully qualified path to the `public` directory. You can set env variable `PUBLIC_PATH` and it'll return the same instead of the default `public`. | ||
|
||
#### config_path | ||
Get the fully qualified path to the `config` directory (Mostly used with Laravel Packages). | ||
|
||
#### database_path | ||
Get the fully qualified path to the `database` directory (Mostly used with Laravel Packages). | ||
|
||
#### route_parameter | ||
```php | ||
route_parameter($name, $default = null) | ||
``` | ||
Get a given parameter from the route. | ||
|
||
## Contributions | ||
|
||
PRs are Welcome :) | ||
|
||
## Additional information | ||
|
||
|
||
Any issues, please [report here](https://github.com/irazasyed/larasupport/issues). | ||
|
||
## License | ||
|
||
[MIT](LICENSE) © [Syed Irfaq R.](http://lk.gd/irazasyed) |