Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devtical/compack
Template-based composer package generator
https://github.com/devtical/compack
composer generator laravel package php
Last synced: 3 days ago
JSON representation
Template-based composer package generator
- Host: GitHub
- URL: https://github.com/devtical/compack
- Owner: devtical
- License: mit
- Created: 2022-10-18T18:29:35.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-22T09:17:28.000Z (about 2 years ago)
- Last Synced: 2023-12-23T18:02:27.662Z (11 months ago)
- Topics: composer, generator, laravel, package, php
- Language: PHP
- Homepage:
- Size: 540 KB
- Stars: 3
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Introduction
Template-based composer package generator.
| Repository | Code |
|---|---|
| [Generic PHP](https://github.com/devtical/compack-template-generic) | `devtical/compack-template-generic`|
| [Laravel](https://github.com/devtical/compack-template-laravel) | `devtical/compack-template-laravel` |
| Yours | *Docs soon* |
## Installation
```bash
composer global require devtical/compack
```
Make sure to place composer's system-wide vendor bin directory in your `$PATH` so the compack executable can be located by your system.
This directory exists in different locations based on your operating system; however, some common locations include:
| OS | Location |
|----|----------|
| macOS | `$HOME/.composer/vendor/bin` |
| Windows | `%USERPROFILE%\AppData\Roaming\Composer\vendor\bin` |
| GNU / Linux Distributions | `$HOME/.config/composer/vendor/bin` or `$HOME/.composer/vendor/bin` |
You could also find the composer's global installation path by running `composer global about` and looking up from the first line.
## Usage
Once installed, the `compack new` command will create a new package in the directory you specify.
### Template from directory
You can refer to the template from your local folder if you don't want to use the templates we provide on GitHub. This is also useful if you are developing templates.
```bash
Template Repository [devtical/compack-template-generic]:
> /Users/kristories/templates/my-awesome-template
```
## Change log
Please see the [changelog](CHANGELOG.md) for more information on what has changed recently.
## Testing
```bash
$ composer test
```
## Contributing
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
## Security
If you discover any security related issues, please email author instead of using the issue tracker.
## Credits
- [Wahyu Kristianto](https://github.com/devtical)
- [All contributors](https://github.com/devtical/compack/graphs/contributors)
## License
The MIT License (MIT). Please see the [license file](LICENSE.md) for more information.