Merge pull request #12 from thecodingmachine/real-boilerplate

Make a ready-to-user boilerplate and update documentation

Author: Julien Neuhart

.env.dist

@@ -5,8 +5,10 @@
 # dummy values and variables you want to reuse
 # in two or more services.
 
+APP_NAME=Symfony Boilerplate
+
 # Domain
-DOMAIN=companies-and-products.localhost
+DOMAIN=symfony-boilerplate.localhost
 API_SUBDOMAIN=api
 STORAGE_SUBDOMAIN=minio
 
@@ -15,7 +17,7 @@ APP_SECRET=$ecretf0rt3st
 
 # MySQL
 MYSQL_ROOT_PASSWORD=super-secret
-MYSQL_DATABASE=companies-and-products
+MYSQL_DATABASE=symfony-boilerplate
 MYSQL_USER=api-agent
 MYSQL_PASSWORD=secret
 
@@ -28,8 +30,5 @@ STORAGE_PRIVATE_BUCKET=private
 STORAGE_ACCESS_KEY=accesskey
 STORAGE_SECRET_KEY=secretkey
 
-# Public storage folders.
-PUBLIC_STORAGE_PRODUCT_PICTURE=product_picture
-
 # i18n
 DEFAULT_LOCALE=en

Makefile

@@ -1,6 +1,6 @@
 # Those variables are only used for the Vagrant command!
 VAGRANT_BOX=bento/ubuntu-20.04
-VAGRANT_PROJECT_NAME=companies-and-products
+VAGRANT_PROJECT_NAME=symfony-boilerplate
 VAGRANT_MEMORY=4096
 VAGRANT_CPUS=2
 VAGRANT_DOCKER_COMPOSE_VERSION=1.27.3

README.md

@@ -12,11 +12,11 @@ This is a template of a *README*. Adapt it according to the comments and your ne
 
 ---
 
-# Companies and products
+# Symfony Boilerplate
 
 > Replace this title and the following description with your project name and description.
 
-This project is an example of a web application built with Nuxt.js, Symfony 5, and GraphQL.
+A web application built with Nuxt.js, Symfony 5, and GraphQL.
 
 ## Setup
 
@@ -48,12 +48,12 @@ For instance, instead of running `make up`, run `docker-compose up -d`.
 Update your `hosts` file with the following entries:
 
 ```
-127.0.0.1   traefik.companies-and-products.localhost
-127.0.0.1   companies-and-products.localhost
-127.0.0.1   api.companies-and-products.localhost
-127.0.0.1   phpmyadmin.companies-and-products.localhost
-127.0.0.1   minio.companies-and-products.localhost
-127.0.0.1   mailhog.companies-and-products.localhost
+127.0.0.1   traefik.symfony-boilerplate.localhost
+127.0.0.1   symfony-boilerplate.localhost
+127.0.0.1   api.symfony-boilerplate.localhost
+127.0.0.1   phpmyadmin.symfony-boilerplate.localhost
+127.0.0.1   minio.symfony-boilerplate.localhost
+127.0.0.1   mailhog.symfony-boilerplate.localhost
 ```
 
 > Update the domain with the one used in your project.
@@ -128,12 +128,12 @@ The containers will be ready faster next time you run this command as the first
 
 Once everything is ready, the following endpoints should be available:
 
-* http://traefik.companies-and-products.localhost (Reverse proxy, the entry point of all the HTTP requests)
-* http://companies-and-products.localhost (Web application)
-* http://api.companies-and-products.localhost (API)
-* http://phpmyadmin.companies-and-products.localhost (phpMyAdmin, a web interface for your MySQL database)
-* http://minio.companies-and-products.localhost (S3 compatible storage)
-* http://mailhog.companies-and-products.localhost (Emails catcher)
+* http://traefik.symfony-boilerplate.localhost (Reverse proxy, the entry point of all the HTTP requests)
+* http://symfony-boilerplate.localhost (Web application)
+* http://api.symfony-boilerplate.localhost (API)
+* http://phpmyadmin.symfony-boilerplate.localhost (phpMyAdmin, a web interface for your MySQL database)
+* http://minio.symfony-boilerplate.localhost (S3 compatible storage)
+* http://mailhog.symfony-boilerplate.localhost (Emails catcher)
 
 > Update the domain with the one used in your project.
 

docker-compose.yml

@@ -39,21 +39,21 @@ services:
       # Either Vagrant or Docker requires the usage of polling, otherwise Nuxt.js does not recompile our code
       # as fast as we would like.
       CHOKIDAR_USEPOLLING: "1"
-      CHOKIDAR_INTERVAL: "1000" # Lower values might increase CPU usage.
+      CHOKIDAR_INTERVAL: "3000" # Lower values might increase CPU usage.
       # Host 0.0.0.0 is designated to tell Nuxt.js to resolve a host address, which is accessible to connections outside
       # of the host machine.
       HOST: "0.0.0.0"
       # Nuxt.js
       # ---------------------
+      APP_NAME: "$APP_NAME"
       # API.
       API_URL: "http://$API_SUBDOMAIN.$DOMAIN/"
       # GraphQL.
       GRAPHQL_URL: "http://$API_SUBDOMAIN.$DOMAIN/graphql"
       # Public storage.
       # Access to these files is done via URLs created using:
-      # "$PUBLIC_STORAGE_URL" + "$PUBLIC_STORAGE_PRODUCT_PICTURE" + "/" + filename.
+      # "$PUBLIC_STORAGE_URL" + folder + "/" + filename.
       PUBLIC_STORAGE_URL: "http://$STORAGE_SUBDOMAIN.$DOMAIN/public/"
-      PUBLIC_STORAGE_PRODUCT_PICTURE: "$PUBLIC_STORAGE_PRODUCT_PICTURE"
       # i18n.
       DEFAULT_LOCALE: "$DEFAULT_LOCALE"
       # LogRocket.
@@ -82,6 +82,7 @@ services:
       STARTUP_COMMAND_4: "php bin/console app:init-storage:s3"
       # Symfony.
       # ---------------------
+      APP_NAME: "$APP_NAME"
       APP_ENV: "dev"
       APP_DEBUG: "1"
       # Note: in your remote environments, make sure you do not change
@@ -108,14 +109,12 @@ services:
       STORAGE_PRIVATE_BUCKET: "$STORAGE_PRIVATE_BUCKET"
       STORAGE_ACCESS_KEY: "$STORAGE_ACCESS_KEY"
       STORAGE_SECRET_KEY: "$STORAGE_SECRET_KEY"
-      # Public storage folders.
-      PUBLIC_STORAGE_PRODUCT_PICTURE: "$PUBLIC_STORAGE_PRODUCT_PICTURE"
       # i18n.
       DEFAULT_LOCALE: "$DEFAULT_LOCALE"
       # Mailer.
       MAILER_DSN: "smtp://null:null@mailhog:1025"
       MAIL_FROM_ADDRESS: "no-reply@$DOMAIN"
-      MAIL_FROM_NAME: "Companies and products"
+      MAIL_FROM_NAME: "$APP_NAME"
       MAIL_WEBAPP_URL: "http://$DOMAIN/"
       MAIL_WEBAPP_UPDATE_PASSWORD_ROUTE_FORMAT: "%s/update-password/%s/%s" # {locale}/update-password/{resetPasswordTokenId}/{plainToken}
     volumes:

docs/docs/1_Get Started/1_1_Overview.md docs/docs/01_Get Started/1_Overview.mddocs/docs/1_Get Started/1_1_Overview.md renamed to docs/docs/01_Get Started/1_Overview.md

@@ -1,6 +1,6 @@
 ---
 title: Overview
-slug: /api/overview
+slug: /api
 ---
 
 We built the API with [Symfony 5](https://symfony.com/), [TDBM](https://github.com/thecodingmachine/tdbm), and