narrowspark / skeleton-generators
The narrowspark skeleton generators.
Fund package maintenance!
prisis
Installs: 109
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 2
Forks: 2
Open Issues: 2
Type:automatic-skeleton
Requires
- php: ^7.3
Requires (Dev)
- cakephp/chronos: ^1.2.2
- mockery/mockery: ^1.2.4
- narrowspark/automatic-common: ^0.13.0
- narrowspark/coding-standard: ^3.2.0
- narrowspark/testing-helper: ^8.0.2
- phpunit/phpunit: ^8.4.2
- slam/phpstan-extensions: ^3.6.1
This package is auto-updated.
Last update: 2023-03-26 11:42:09 UTC
README
Branch Status
Installation
Note: this package can be only used with automatic.
Use Composer to install this package:
composer require narrowspark/skeleton-generators
Default Directories
Narrowspark automatically ships with a default directory structure. You can easily override this directory structure to create your own.
The default directory structure is.
your-project/ ├─ app/ │ ├─ Console/ │ ├─ └─ Kernel.php │ ├─ Provider/ │ └─ ... ├─ config/ │ └─ ... ├─ public/ │ └─ index.php ├─ resources/ │ └─ ... ├─ routes/ │ ├─ api.php │ └─ ... ├─ storage/ │ ├─ app/ │ ├─ framework/ │ ├─ logs/ │ └─ ... ├─ tests/ │ ├─ AbstractTestCase.php │ ├─ bootstrap.php │ └─ ... ├─ cerebro └─ vendor/
Override the Directories
You can change the default directories by overriding the composer extra section of your app:
{ "extra": { "app-dir": "app", "config-dir": "config", "database-dir": "database", "public-dir": "public", "resources-dir": "resources", "routes-dir": "routes", "storage-dir": "storage", "tests-dir": "tests" } }
The root-dir
key may be only used if your project is in a sub folder of your main project.
Generators
- Console
The Console Generator
is a micro-framework that provides an elegant starting point for your console app.
- Http
The Http Generator
is a micro-framework that provides an elegant starting point for your next web app.
Testing
You need to run:
$ php vendor/bin/phpunit
Contributing
If you would like to help take a look at the list of issues and check our Contributing guild.
Note: please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
Credits
License
The MIT License (MIT). Please see License File for more information.