Merge pull request #447 from org-SCAN/doc-sail

feat(doc)✨ : complete the sail documentation

README.md

@@ -6,13 +6,34 @@ Site web du projet :)
 
 # Start the project
 
-## Using SAIL
+## Using SAIL (recommended)
 
-To run the project, you must have docker and docker-compose installed on your machine.
+To run the project, you must have : 
+- [Docker](https://docs.docker.com/engine/install/)
+- [Composer](https://getcomposer.org/doc/00-intro.md)
+- [PHP](https://www.php.net/manual/fr/install.php)
 
-Following the [laravel sail documentation](https://laravel.com/docs/10.x/sail#installing-sail-into-existing-applications.
+You need to create a `.env` file in the `src` directory based on the `.env.example` file.  
+> 💡 When you code you should switch the `APP_DEBUG` to `true` to see the errors.  
 
+You can now start Docker and follow the [laravel sail documentation](https://laravel.com/docs/10.x/sail#installing-sail-into-existing-applications)
+more specifically the installation part.  
+Once the installation is done you can run the following command to start the project :
 
+```bash
+./vendor/bin/sail up -d #-d to detach the process, you can create an alias for sail later
+#Run these in the docker container
+npm update
+cd /var/www/html
+composer update
+php artisan cache:clear
+composer dump-autoload
+php artisan key:generate
+chmod -R 777 storage/
+php artisan migrate:refresh --seed
+```
+
+You can now access the website at [localhost:80](http://localhost:80).
 
 
 ## Using docker

src/.env.example

@@ -5,7 +5,7 @@ APP_DEBUG=false
 APP_URL=
 
 DB_CONNECTION=mysql
-DB_HOST=
+DB_HOST=mysql
 DB_PORT=3306
 DB_DATABASE=database_name
 DB_USERNAME='USER'
@@ -50,4 +50,4 @@ DEFAULT_PASSWORD="password123"
 DEFAULT_TEAM="default_team"
 
 TRANSLATION_API_URL="https://api-free.deepl.com/v2/translate"
-TRANSLATION_API_TOKEN="YOUR_API_TOKEN
+TRANSLATION_API_TOKEN="YOUR_API_TOKEN"

src/app/Models/Translation.php

@@ -58,11 +58,8 @@ public function getLanguageAttribute($value)
     public function autoTranslate()
     {
         foreach (Language::otherLanguages() as $language) {
-            if(env("TRANSLATION_API_URL") == null || env("TRANSLATION_API_TOKEN") == null){
-                Translation::handleTranslation(ListControl::find($this->list), $this->field_key, $this->translation, $language->id);
-            }
-            else{
-                // create post request to deepl
+            // check that the API token and url are set and if not use the default translation
+            try{
                 $response = Http::withHeaders([
                     'Authorization' => "DeepL-Auth-Key " . env("TRANSLATION_API_TOKEN")
                 ])->withBody(http_build_query([
@@ -73,6 +70,10 @@ public function autoTranslate()
                 $content = $response->json()["translations"][0]["text"];
                 Translation::handleTranslation(ListControl::find($this->list), $this->field_key, $content, $language->id);
             }
+            catch(\Exception $e){
+                // if the translation fails, use the default translation
+               Translation::handleTranslation(ListControl::find($this->list), $this->field_key, $this->translation, $language->id);
+            }
         }
     }