Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greeflas/default-project
This is a default structure for PHP projects.
https://github.com/greeflas/default-project
default-project php project-template skeleton skeleton-application
Last synced: about 1 month ago
JSON representation
This is a default structure for PHP projects.
- Host: GitHub
- URL: https://github.com/greeflas/default-project
- Owner: greeflas
- License: bsd-3-clause
- Created: 2018-09-17T07:55:56.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-03T03:17:28.000Z (over 3 years ago)
- Last Synced: 2024-04-25T18:22:25.443Z (7 months ago)
- Topics: default-project, php, project-template, skeleton, skeleton-application
- Language: PHP
- Homepage:
- Size: 110 KB
- Stars: 24
- Watchers: 5
- Forks: 6
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Default Project
===============
This is a default structure for PHP projects. With this template you can speed up the process of creating of new:
open-source, proprietary, test, demo and etc. projects!
This template has basic configuration for [PHPUnit](https://github.com/sebastianbergmann/phpunit) and
[PHP-CS-Fixer](https://github.com/friendsofphp/php-cs-fixer) libraries, configured `composer.json`
with PSR-4 namespaces for source code and tests, `.gitignore` with basic files and directories to exclude them from Git, changelog file
and README with cool badges :)
[](CHANGELOG.md)
[](https://packagist.org/packages/greeflas/default-project)
Installation
------------
For creating new project based on this template just execute the following command
```bash
$ composer create-project greeflas/default-project project-name
```
> NOTE: You can add `--no-dev` right after `create-project` flag if you don't want to install dev dependencies to your project
Usage
-----
Main changes that you need to do:
1. Update `name`, `description`, `keywords`, `authors` section of the `composer.json` file, [lines 2-4](composer.json#L2-L4), [9-10](composer.json#L9-L10).
2. Update header template in `.php_cs.dist` file, [lines 4-9](.php_cs.dist#L4-L9).
3. Update copyright in `LICENSE` file, [line 3](LICENSE#L3).
Other changes that you may do:
1. Change namespace for source code in `composer.json`, [line 23](composer.json#L23) and for tests [line 28](composer.json#L28).
2. Change PHP version in `composer.json` [line 16](composer.json#L15).
3. Change rules for code style in `.php_cs.dist` file.
4. Add some new files and directories to `.gitignore` file to exclude them from Git.
5. Update readme according to your project
6. Update changelog according to your project
Code style fixer
----------------
To check the code style just run the following command
```bash
$ composer cs-check
```
to fix the code style run next command
```bash
$ composer cs-fix
```
Tests
-----
You can run tests with composer command
```bash
$ composer tests
```
License
-------
[](LICENSE)
This project is released under the terms of the BSD-3-Clause [license](LICENSE).
Copyright (c) 2018 - 2020, Volodymyr Kupriienko