🍳 RecipeBook

A modern Symfony recipe management application

RecipeBook is a Symfony web application for creating, organizing, and managing recipes and categories.
It includes a clean Bootstrap interface, Doctrine entities, admin CRUD pages, recipe validation, automatic slug generation, and a contact form powered by Symfony Mailer.

---

✨ Features

• 🍽️ Recipe listing and management
• 🏷️ Category management
• ✍️ Create, edit, and delete recipes
• 🧾 Create, edit, and delete categories
• 🔗 Automatic slug generation
• ⏱️ Recipe duration tracking
• ✅ Symfony form validation
• 🚫 Custom banned-word validator
• 📬 Contact form with email sending
• 🎨 Responsive Bootstrap UI
• 🗃️ PostgreSQL database support with Docker
• 🧱 Doctrine ORM entities and repositories
• 🧪 PHPUnit test setup included

---

🧠 What It Does

RecipeBook lets users manage a small collection of cooking recipes.

The application has a public homepage that highlights quick recipes and an admin area where recipes and categories can be created, edited, and removed.

User
 │
 │ visits homepage / contact page
 ▼
Symfony Controllers
 │
 ├── HomeController
 ├── ContactController
 └── Admin Controllers
      ├── RecipesController
      └── CategoryController
 │
 ▼
Forms + Validation
 │
 ├── RecipeType
 ├── CategoryType
 ├── ContactType
 └── BanWords Validator
 │
 ▼
Doctrine ORM
 │
 ├── Recipe
 ├── Category
 └── Duration
 │
 ▼
PostgreSQL Database

---

🛠️ Tech Stack

Tool	Purpose
PHP 8.1+	Backend language
Symfony 6.4	Main web framework
Doctrine ORM	Database mapping
PostgreSQL 16	Database
Twig	HTML templating
Bootstrap 5	UI styling
Symfony Forms	Form handling
Symfony Validator	Data validation
Symfony Mailer	Contact email sending
Docker Compose	Local database and mail services
PHPUnit	Testing setup

---

📁 Project Structure

RecipeBook-main/
├── assets/
│   ├── app.js
│   ├── bootstrap.js
│   └── controllers.json
│
├── bin/
│   ├── console
│   └── phpunit
│
├── config/
│   ├── bundles.php
│   ├── routes.yaml
│   └── services.yaml
│
├── migrations/
│   ├── Version20251002142557.php
│   ├── Version20251002143247.php
│   ├── Version20251013124122.php
│   └── Version20251014084721.php
│
├── public/
│   ├── .htaccess
│   └── index.php
│
├── src/
│   ├── Controller/
│   │   ├── ContactController.php
│   │   ├── HomeController.php
│   │   └── Admin/
│   │       ├── CategoryController.php
│   │       └── RecipesController.php
│   │
│   ├── DTO/
│   │   └── ContactDTO.php
│   │
│   ├── Entity/
│   │   ├── Category.php
│   │   ├── Duration.php
│   │   └── Recipe.php
│   │
│   ├── Form/
│   │   ├── CategoryType.php
│   │   ├── ContactType.php
│   │   ├── FormListenerFactory.php
│   │   └── RecipeType.php
│   │
│   ├── Repository/
│   │   ├── CategoryRepository.php
│   │   ├── DurationRepository.php
│   │   └── RecipeRepository.php
│   │
│   ├── Validator/
│   │   ├── BanWords.php
│   │   └── BanWordsValidator.php
│   │
│   └── Kernel.php
│
├── templates/
│   ├── base.html.twig
│   ├── admin/
│   │   ├── admin.html.twig
│   │   ├── category/
│   │   └── recipe/
│   ├── contact/
│   ├── emails/
│   ├── home/
│   └── partials/
│
├── tests/
├── translations/
├── compose.yaml
├── compose.override.yaml
├── composer.json
├── importmap.php
├── phpunit.dist.xml
└── symfony.lock

---

🚀 Getting Started

1. Clone the repository

git clone <your-repository-url>
cd RecipeBook-main

---

2. Install PHP dependencies

composer install

---

3. Start the database

The project includes Docker Compose configuration for PostgreSQL.

docker compose up -d

This starts a PostgreSQL database using the settings from compose.yaml.

Default database values:

POSTGRES_DB=app
POSTGRES_USER=app
POSTGRES_PASSWORD=!ChangeMe!

---

4. Configure environment variables

Create or update your .env.local file:

DATABASE_URL="postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=16&charset=utf8"
MAILER_DSN=smtp://localhost:1025

---

5. Run database migrations

php bin/console doctrine:migrations:migrate

---

6. Start the Symfony server

symfony server:start

Or with PHP’s built-in server:

php -S localhost:8000 -t public

Then open:

http://localhost:8000

---

🧭 Main Routes

Route	Name	Description
/	home	Homepage with featured recipes
/contact	contact	Contact form
/admin/recipe/	admin.recipe.index	List all recipes
/admin/recipe/create	admin.recipe.create	Create a recipe
/admin/recipe/{id}/edit	admin.recipe.edit	Edit a recipe
/admin/recipe/{id}/delete	admin.recipe.remove	Delete a recipe
/admin/category/	admin.category.index	List all categories
/admin/category/create	admin.category.create	Create a category
/admin/category/{id}/edit	admin.category.edit	Edit a category
/admin/category/{id}/delete	admin.category.remove	Delete a category

---

🍽️ Recipe Management

Recipes are represented by the Recipe entity.

A recipe contains:

Field	Description
id	Unique recipe identifier
title	Recipe title
slug	URL-friendly recipe slug
content	Recipe description or instructions
duration	Cooking duration in minutes
category	Related category
createdAt	Creation date
updatedAt	Last update date

The recipe form supports automatic slug creation using the recipe title.

->addEventListener(FormEvents::PRE_SUBMIT, $this->factory->autoSlug('title'))

---

🏷️ Category Management

Categories are represented by the Category entity.

A category contains:

Field	Description
id	Unique category identifier
name	Category name
slug	URL-friendly category slug
createdAt	Creation date
updatedAt	Last update date
recipes	Recipes linked to the category

Each category can contain multiple recipes through a Doctrine OneToMany relationship.

---

📬 Contact Form

The application includes a contact page powered by:

• ContactController
• ContactDTO
• ContactType
• Symfony Mailer
• TemplatedEmail

The form collects:

Field	Description
service	Selected recipient service
name	Sender name
email	Sender email
message	Message content

Available services:

Label	Email
Accounting	accounting@demo.fr
Support	support@demo.fr
Marketing	marketing@demo.fr

For local development, the Docker setup includes Mailpit.

Open the Mailpit interface at the port exposed by Docker to preview outgoing emails.

---

✅ Validation

The project uses Symfony validation constraints on entities and DTOs.

Examples include:

• Required contact fields
• Valid email address
• Minimum title length
• Unique recipe titles
• Unique recipe slugs
• Unique category names
• Unique category slugs
• Slug format validation
• Maximum recipe duration of 1440 minutes

---

🚫 Custom Validator

Recipe titles use a custom BanWords validator.

By default, it blocks titles containing:

spam
macron

The validator lives in:

src/Validator/BanWords.php
src/Validator/BanWordsValidator.php

---

🧪 Running Tests

Run the test suite with:

php bin/phpunit

Or:

vendor/bin/phpunit

---

🧰 Useful Commands

Clear Symfony cache

php bin/console cache:clear

Create a new migration

php bin/console make:migration

Run migrations

php bin/console doctrine:migrations:migrate

Check routes

php bin/console debug:router

Check services

php bin/console debug:container

Validate Doctrine schema

php bin/console doctrine:schema:validate

---

🎨 Interface

RecipeBook uses Twig templates and Bootstrap to provide a clean, responsive interface.

Main UI pages include:

Template	Purpose
templates/base.html.twig	Main layout with navbar and styling
templates/home/index.html.twig	Homepage
templates/admin/recipe/index.html.twig	Recipe list
templates/admin/recipe/create.html.twig	Recipe creation
templates/admin/recipe/edit.html.twig	Recipe edition
templates/admin/category/index.html.twig	Category list
templates/admin/category/create.html.twig	Category creation
templates/admin/category/edit.html.twig	Category edition
templates/contact/contact.html.twig	Contact page
templates/emails/contact.html.twig	Contact email template

---

🧱 Database

The application uses Doctrine ORM with PostgreSQL.

Main entities:

Recipe
Category
Duration

Relationship overview:

Category 1 ──── * Recipe

A category can have many recipes. A recipe can belong to one category.

---

🐳 Docker Services

The project includes Docker Compose services for local development.

PostgreSQL

Configured in:

compose.yaml

Mailpit

Configured in:

compose.override.yaml

Mailpit is useful for testing contact form emails without sending real emails.

---

📌 Development Notes

This project is a practical Symfony application focused on:

• MVC architecture
• Doctrine entity relationships
• Symfony forms
• Form event listeners
• Custom validation
• Twig templating
• Bootstrap UI
• Mail handling
• Database migrations

---

🚧 Possible Improvements

Ideas for future improvements:

• Add user authentication
• Protect admin routes
• Add recipe detail pages
• Upload recipe images
• Add recipe search and filters
• Add pagination
• Add fixtures for demo data
• Add API endpoints
• Improve category timestamps with lifecycle callbacks
• Add CSRF handling for delete routes with real DELETE method support
• Add automated functional tests

---

Built with Symfony, Twig, Doctrine, and a love for good recipes. 🍝✨