Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/salsan/php
This is a template created for my projects in PHP
https://github.com/salsan/php
composer php php8 phpunit template template-project
Last synced: 7 days ago
JSON representation
This is a template created for my projects in PHP
- Host: GitHub
- URL: https://github.com/salsan/php
- Owner: salsan
- License: mit
- Created: 2022-12-30T17:28:32.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T15:35:19.000Z (4 months ago)
- Last Synced: 2024-11-09T04:36:19.657Z (2 months ago)
- Topics: composer, php, php8, phpunit, template, template-project
- Homepage: https://github.com/salsan/PHP
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP Template
A minimal and flexible PHP template to kickstart your PHP projects, including development tools for linting, testing, and ensuring code quality. Designed to help you get started quickly and maintain best practices.
## Features
- **[Composer](https://getcomposer.org/)** for dependency management
- **[PHPUnit](https://phpunit.de/)** for unit testing
- **[PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer)** for enforcing coding standards
- **[PHPStan](https://phpstan.org/)** for static analysis
- Fully **[PSR-12](https://www.php-fig.org/psr/psr-12/)** compliant
- Suggested **[VSCode extensions](https://raw.githubusercontent.com/salsan/PHP/main/.vscode/extensions.json)** for an optimized development environment
## Requirements
- [**PHP**](https://www.php.net/downloads.php) 8.1.10 or higher
- [**Composer**](https://getcomposer.org/) (latest version)
- [**Git**](https://git-scm.com/) for cloning the repository
- Optional: **[VSCode](https://code.visualstudio.com/?wt.mc_id=vscom_downloads)** with suggested extensions
## Getting Started
### Installation
1. Clone the repository:
```bash
git clone https://github.com/salsan/PHP.git
cd PHP
```
2. Install dependencies via Composer:
```bash
composer install
```
3. Run tests to ensure everything is set up correctly:
```bash
./vendor/bin/phpunit
```
### Usage
1. Start writing your PHP code in the `src/` directory.
2. Add your tests in the `tests/` directory.
3. Run the following commands to ensure code quality:
```bash
# Run PHPUnit tests
./vendor/bin/phpunit
# Run PHP Code Sniffer
./vendor/bin/phpcs
# Run PHPStan
./vendor/bin/phpstan analyse src tests
```
## Project Structure
```
.
├── src/ # Your source code
├── tests/ # Test files
├── vendor/ # Composer dependencies
├── .gitignore
├── .phpcs.xml # PHP Code Sniffer configuration
├── composer.json
├── phpstan.neon # PHPStan configuration
├── phpunit.xml # PHPUnit configuration
└── README.md
```
## Contributing
Contributions are welcome! To contribute:
1. Fork the repository.
2. Create a new branch for your feature or bugfix: `git checkout -b feature/your-feature-name`
3. Make your changes and commit them: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin feature/your-feature-name`
5. Submit a pull request with a clear description of your changes.
Please make sure to follow **PSR-12** coding standards and add tests for new features.
## Bug Reports
If you encounter any issues or bugs, please [open an issue](https://github.com/salsan/PHP/issues) on the GitHub repository.
## License
This project is licensed under the [MIT License](https://raw.githubusercontent.com/salsan/PHP/main/LICENSE).