https://github.com/tidjee-dev/symfony-template

This repository is a boilerplate for quickly setting up a new Symfony 7 project with a ready-to-use Docker configuration in a dev environment.
https://github.com/tidjee-dev/symfony-template

castor development php symfony

Last synced: about 1 month ago
JSON representation

This repository is a boilerplate for quickly setting up a new Symfony 7 project with a ready-to-use Docker configuration in a dev environment.

• Host: GitHub
• URL: https://github.com/tidjee-dev/symfony-template
• Owner: tidjee-dev
• Created: 2025-02-08T21:53:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-14T12:09:52.000Z (about 1 year ago)
• Last Synced: 2025-06-14T13:18:36.971Z (about 1 year ago)
• Topics: castor, development, php, symfony
• Language: PHP
• Homepage:
• Size: 106 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Tidjee's Symfony 7 Template

![GitHub stars](https://img.shields.io/github/stars/tidjee-dev/symfony-template?style=) [![GitHub last commit](https://img.shields.io/github/last-commit/tidjee-dev/symfony-template)](https://github.com/tidjee-dev/symfony-template/commits/main) [![GitHub issues](https://img.shields.io/github/issues/tidjee-dev/symfony-template)](https://github.com/tidjee-dev/symfony-template/issues) [![GitHub forks](https://img.shields.io/github/forks/tidjee-dev/symfony-template?style)](https://github.com/tidjee-dev/symfony-template/fork) ![GitHub repo size](https://img.shields.io/github/repo-size/tidjee-dev/symfony-template) [![Use this template](https://img.shields.io/badge/Use%20this%20template-blueviolet?logo=github)](https://github.com/tidjee-dev/symfony-template/generate)

## 📝 Description

This repository is a boilerplate for quickly setting up a new Symfony 7 project with a ready-to-use Docker configuration in a dev environment.

> [!WARNING]

> The Docker configuration in this template is for development purposes only (for now).

> It is not intended for production use.

It provides:

✅ An **Apache web server**

✅ Support for **SQLite** or **MySQL** databases

✅ Database management tools: **PHPMyAdmin**

✅ **Mailpit** as fake SMTP server

✅ A **Docker** environment for easy setup

✅ **Castor** as a task runner

## 🚀 Tech Stack

- **Languages & Database**

  [![PHP](https://img.shields.io/badge/PHP-8.4.x-777BB4?logo=php)](https://www.php.net/) [![MySQL](https://img.shields.io/badge/MySQL-latest-4479A1?logo=mysql)](https://www.mysql.com/) [![SQLite](https://img.shields.io/badge/SQLite-latest-4479A1?logo=sqlite)](https://www.sqlite.org/)

- **Frameworks**

  [![Symfony](https://img.shields.io/badge/Symfony-latest-000?logo=symfony)](https://symfony.com/)

- **Web Server**

  [![Apache]()](https://httpd.apache.org/)

- **Mail Server**

  [![Mailpit](https://img.shields.io/badge/Mailpit-latest-000)](https://mailpit.axllent.org/)

- **Tools**

  [![Castor](https://img.shields.io/badge/Castor-latest-000)](https://castor.jolicode.com/) [![Docker](https://img.shields.io/badge/Docker-latest-0db7ed?logo=docker)](https://docs.docker.com/) [![PHPMyAdmin](https://img.shields.io/badge/PHPMyAdmin-latest-4479A1?logo=phpmyadmin)](https://www.phpmyadmin.net/)

## 📌 Requirements

Before using this template, ensure you have:

- [PHP](https://www.php.net/) installed

- [Castor](https://castor.jolicode.com/installation) installed

- [Docker](https://docs.docker.com/engine/install/) & [Docker Compose](https://docs.docker.com/compose/)

## 🛠️ How to Use

1. **Create** a new Symfony project using this template

   ![use this template](/docs/template/assets/image.png)

2. **Clone** your newly created repository

3. **Initialize the project** with:

   ```sh

   castor project:init

   ```

4. **Adapt the Docker configuration** to your needs

   Follow the instructions in the `compose.dev.yml` file to configure the Docker development environment.

5. **Start the Docker Stack** with:

   ```sh

   castor docker:start

   ```

## 🤝 Contributing

If you have any suggestions or find any issues, please [open an issue](https://github.com/tidjee-dev/symfony-template/issues/new).

## 🎉 Happy Coding! 🚀