Product Analysis

Overview

The Symfony Boilerplate is a web application built with Nuxt.js 2, Symfony 5.4 (LTS), and GraphQL 5. It provides a template of a README that can be adapted for different projects. The boilerplate includes a setup guide for Linux, macOS, and Windows, as well as instructions for configuring the environment variables and starting the Docker containers.

Features

• Template README for easy adaptation
• Built with Nuxt.js, Symfony, and GraphQL
• Docker-based setup for easy deployment

Installation

1. Prerequisites

   • Linux: Install Docker and Docker Compose.
   • macOS: Consider installing Vagrant and VirtualBox to overcome performance issues with Docker on macOS.
   • Windows: Consider using a Linux-like terminal or Vagrant for better performance. Alternatively, run commands specified in the Makefile.

2. Hosts

   • Update the hosts file on your machine with the necessary entries. On Linux and macOS, run sudo nano /etc/hosts to edit it. On Windows, edit C:\Windows\System32\drivers\etc\hosts with administrative privileges.

3. First Start

   • Copy the file .env.dist to .env and edit the latter to update the default values of environment variables (e.g., DOMAIN, MYSQL_DATABASE, APP_SECRET).
   • If using Vagrant, comment out the STARTUP_COMMAND_3 and STARTUP_COMMAND_4 environment variables in the docker-compose.yml file.
   • Run the appropriate commands based on your setup:
     • Linux and Windows users: make up
     • Vagrant users: vagrant up and vagrant ssh
   • Update the VAGRANT_PROJECT_NAME variable in the .env and .env.dist files with your project name.
   • Start the Docker containers with the command make vagrant. It may take some time as the containers install dependencies, compile sources, and run migrations.

Summary

The Symfony Boilerplate is a web application template built with Nuxt.js, Symfony, and GraphQL. It provides a convenient starting point for new projects and offers detailed instructions for installation and setup. The use of Docker simplifies deployment, and the template can be easily customized for different project requirements.