Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jekwwer/symfony-template
A ready-to-use Symfony template for quick project setup, featuring a devcontainer environment, automated updates, and testing configuration.
https://github.com/jekwwer/symfony-template
composer devcontainer docker php phpunit symfony template vscode web-development
Last synced: 7 days ago
JSON representation
A ready-to-use Symfony template for quick project setup, featuring a devcontainer environment, automated updates, and testing configuration.
- Host: GitHub
- URL: https://github.com/jekwwer/symfony-template
- Owner: Jekwwer
- License: mit
- Created: 2024-11-07T16:01:28.000Z (10 days ago)
- Default Branch: main
- Last Pushed: 2024-11-10T12:08:28.000Z (7 days ago)
- Last Synced: 2024-11-10T12:24:22.291Z (7 days ago)
- Topics: composer, devcontainer, docker, php, phpunit, symfony, template, vscode, web-development
- Language: PHP
- Homepage:
- Size: 154 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Symfony Project Template
This repository serves as a template for creating Symfony projects with a fully configured development environment, including Docker-based devcontainer support, Dependabot integration, pre-configured tools, and a deploy workflow for GitHub Pages.
## Features
- **Symfony 7**: Modern PHP framework for web applications.
- **Devcontainer Support**: Run the project in a consistent development environment using Docker.
- **VSCode Configuration**: Includes recommended extensions and settings for PHP.
- **Dependabot**: Automated dependency updates for Composer, Docker, and GitHub Actions.
- **Preconfigured PHPUnit**: Testing framework for unit and functional tests.
- **Xdebug Configuration**: Preconfigured for debugging with VSCode.
- **Makefile**: Convenient shortcuts for common tasks.
- **Deploy Workflow**: GitHub Actions workflow for deploying to GitHub Pages.
## Prerequisites
- [Docker](https://docs.docker.com/get-docker/) - Required for the development container.
- [VSCode](https://code.visualstudio.com/) with the [Remote - Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.
## Getting Started
1. **Clone this repository**:
```bash
git clone https://github.com/Jekwwer/symfony-template.git
cd symfony-template
```
2. **Open in VSCode**:
- Open VSCode and use the `Remote - Containers` extension to open the folder in the devcontainer.
- VSCode will automatically build the Docker container and install the necessary dependencies.
3. **Run the Application**:
- Start the Symfony server by running:
```bash
make serve
```
- The application will be available at `http://localhost:8000`.
## Debugging with Xdebug
This template includes Xdebug for PHP debugging. Xdebug is configured to listen for incoming connections, making it easy to debug with VSCode.
> Note: For phpmd, it’s necessary to start debugging; otherwise, the pre-commit hook will fail.
## Project Structure
- **`src/`**: Symfony application source code.
- **`tests/`**: PHPUnit tests.
- **`templates/`**: Twig templates for HTML rendering.
- **`.devcontainer/`**: Docker and devcontainer configuration files.
- **`.env`** and **`.env.test`**: Environment variable files for development and testing.
- **`.github/dependabot.yml`**: Dependabot configuration for automated dependency updates.
- **`.github/workflows/deploy.yml`**: GitHub Actions workflow for deploying the project to GitHub Pages.
## Available Commands
You can use the following commands from the Makefile:
- **`make install`** - Install PHP dependencies via Composer.
- **`make serve`** - Start the Symfony server.
- **`make test`** - Run tests with PHPUnit.
- **`make coverage`** - Run tests with coverage report.
- **`make cache-clear`** - Clear Symfony cache.
## Testing
This template includes a PHPUnit setup. To run tests, use:
```bash
make test
```
To check test coverage:
```bash
make coverage
```
## Automated Dependency Updates
This template uses Dependabot to keep dependencies up-to-date:
- **Docker**: `.devcontainer` Docker dependencies.
- **GitHub Actions**: `.github` workflows.
- **Composer**: PHP dependencies.
## Deployment
This project includes a deploy workflow to publish the application to GitHub Pages. It builds a static version of the Symfony application and deploys it to the `gh-pages` branch.
You can view the deployed application [here](https://jekwwer.github.io/symfony-template/).
## Customizing
Feel free to modify this template to suit your project's needs. You can add new Symfony bundles, customize configurations, or expand the Docker setup as required.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.