Skip to content

Commit

Permalink
add readme and coding standards
Browse files Browse the repository at this point in the history
  • Loading branch information
tychovbh committed May 8, 2019
1 parent 8f16a1e commit 756dcbf
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 3 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip

- remove debug code
- fix config
- add readme
- add coding standards

## V0.6 Alpha 07-05-2019

Expand Down
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,33 @@

Laravel Package Skeleton is created by, and is maintained by Tycho, and is a Laravel/Lumen package to create new packages. Feel free to check out the [change log](CHANGELOG.md), [releases](https://github.com/tychovbh/laravel-package-skeleton/releases), [license](LICENSE.md), and [contribution guidelines](CONTRIBUTING.md)


## Install
Install through composer

composer require --dev tychovbh/laravel-package-skeleton

Run the setup this will create a folder bootstrap/cache. Do not remove this folder at any time

php vendor/tychovbh/laravel-package-skeleton/setup

All Laravel Artisan commands are now available, use the following one to install a package:

php artisan make:skeleton

You will be ask a few questions that will be needed to generate your composer.json file and Service Provider.

## Usage

You are now setup to develop your package with. The package comes with [orchestra/testbench](https://github.com/orchestral/testbench) for writing test cases. But you can decide to use whatever you desire.

Use artisan to generate your controllers, models, migrations etc.

If included during skelleton creation:
- routes should be located in `{project_root}/routes`
- views should be located in `{project_root}/views`
- config should be located in `{project_root}/config`

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
Expand Down
2 changes: 0 additions & 2 deletions setup
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<?php

mkdir('bootstrap/cache', 0777, true);

echo shell_exec('php vendor/tychovbh/laravel-package-skeleton/artisan make:skeleton');
2 changes: 1 addition & 1 deletion src/files/composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"php" : "~7.1"
},
"require-dev": {
"tychovbh/laravel-package-skeleton": "^0.6.0"
"tychovbh/laravel-package-skeleton": "^0.7.0"
},
"autoload": {
"psr-4": {
Expand Down

0 comments on commit 756dcbf

Please sign in to comment.