Browse Source

minor fixes

Olivier Massot 6 months ago
parent
commit
d3a3d218b3
2 changed files with 6 additions and 5 deletions
  1. 1 1
      app/pages/about.vue
  2. 5 4
      readme.md

+ 1 - 1
app/pages/about.vue

@@ -20,7 +20,7 @@
         <a href="https://vuetifyjs.com/en" target="_blank">Vuetify</a> components and
         <a href="https://www.typescriptlang.org/" target="_blank">TypeScript</a>.
 
-        The entire application is served through Caddy web server, offering automatic HTTPS.
+        The entire application is served through <a href="https://caddyserver.com/" target="_blank">Caddy</a> web server, offering automatic HTTPS.
         Enjoy!
       </p>
       <p class="text-center">

+ 5 - 4
readme.md

@@ -8,12 +8,13 @@ technology stack.
 
 The backend is built with [Symfony 7](https://symfony.com/) and [API Platform 4](https://api-platform.com/). 
 The frontend uses [Nuxt.js 3](https://nuxt.com/) with [Vuetify](https://vuetifyjs.com/en) components and [TypeScript](https://www.typescriptlang.org/).
-The entire application is served through Caddy web server, offering automatic HTTPS.
+The entire application is served through [Caddy](https://caddyserver.com/) web server, offering automatic HTTPS.
 Enjoy!
 
 ## Install
 
-Add those lines to your [hosts](https://linuxize.com/post/how-to-edit-your-hosts-file/) file :
+Choose a domain's name for your project (project default: 'snc-demo.net'), then 
+add those lines to your [hosts](https://linuxize.com/post/how-to-edit-your-hosts-file/) file :
 
     127.0.0.1 local.api.<domain>.fr
     127.0.0.1 local.app.<domain>.fr
@@ -26,7 +27,7 @@ Copy the .env file and edit it if needed :
 
     cp .env.skeleton .env
 
-Edit the following files to update the directives with you domain name (default: 'snc-demo.net')
+Edit the following files to update the directives with you domain name 
 
 * docker/api/vhost.conf
 * docker/caddy/Caddyfile
@@ -87,7 +88,7 @@ Start the nuxt server:
 
 ## Try it
 
-At this point, the application shall be served at https://local.app.snc-demo.fr/.
+At this point, the application should be served at https://local.app.snc-demo.fr/.
 
 
 ## Accessing the OpenAPI Interface