Merge pull request #99 from camarm-dev/dev

Version 1.1.0-beta.2, resolved #88, #94, #95, #96, #97, #91
camarm-dev · Feb 4, 2024 · 8d61219 · 8d61219
2 parents aa8f835 + 6b41152
commit 8d61219
Show file tree

Hide file tree

Showing 67 changed files with 879 additions and 167 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,3 +1,2 @@
 data/remede.db filter=lfs diff=lfs merge=lfs -text
 data/remede-less.db filter=lfs diff=lfs merge=lfs -text
-builds/1.0.0/remede-1.0.0-setup.exe filter=lfs diff=lfs merge=lfs -text
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,28 @@
+# This workflow uses actions that are not certified by GitHub.
+# THis workflow checks if the code can build
+name: Code builds
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Build Vue project
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup Environnement
+        run: cd app && npm install
+
+      - name: Build code
+        run: cd app && npm run build
diff --git a/.github/workflows/ressources.yml b/.github/workflows/ressources.yml
@@ -0,0 +1,26 @@
+# This workflow uses actions that are not certified by GitHub.
+# This workflow execute a python scripts to check if ressources are correctly formatted !
+
+name: Ressources format
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+
+jobs:
+  generation:
+    name: Run ressources generation (wordlist, IPA list)
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Run ressources generation
+        run: python3 scripts/pre_generate_ressources.py
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 /.idea/
+/.github.json
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -47,7 +47,7 @@ First, the folders;
 
 ### Lifecycle Schemas
 
-_These schemas are outdated and not really readable. Visit [`INFRASTRUCTURE.md`](INFRASCTRUCTURE.md) for more._
+_These schemas are outdated and not really readable. Visit [`INFRASTRUCTURE.md`](INFRASTRUCTURE.md) for more._
 
 In this section you will understand Remède Lifecycle with different schemas. 
 
@@ -126,10 +126,12 @@ sequenceDiagram
 Remède fetches words from the Wictionary but sometimes, words are not in our list so, you can add custom words...
 
 1. Add it to `data/IPA.txt`
-   1.  At the end of the file, add your word with the following schema `word\t/phonetic/`
+   1.  In alphabetic order, add your word with the following schema `word\t/phonetic/` (`\t` represents a <kbd>TAB</kbd> char, not spaces)
 2. Add it to `data/custom_words.json`, if necessary
    1. Check on the [french Wictionary](https://fr.wiktionary.org) if your word exist.
    2. If it does not exist, fill his document manually in the `data/custom_words.json`. Don't forget to quote your sources in the `credits` field.
+3. Before making a PR, rebuild ressources (so your word will be added newt time database is built)
+   1. Run `python3 scripts/pre_generate_ressources.py`, if it outputs an error, check the previous steps...
 
 ### Parsing
 

diff --git a/INFRASCTRUCTURE.md → INFRASTRUCTURE.md b/INFRASCTRUCTURE.md → INFRASTRUCTURE.md
@@ -18,12 +18,15 @@ graph LR
         subgraph docker["`fa:fa-docker Dedicated Docker Server`"]
             B --> G[TTS service]
             B --> H[Corrector service]
-            B -.-> L[Rimes graph service]
+            B --> L[Rhymes graph service]
         end
         subgraph fa:fa-folder Filesystem
             C --> E[(Database)]
             E --> F[JSON]
         end
+        subgraph fa:fa-folder Filesystem
+            L --> O[(Rhymes graph\ndatabase)]
+        end
     end
 ```
 

diff --git a/PARSING.md b/PARSING.md
@@ -6,6 +6,7 @@ Générer les données Remède consiste à générer **les fichiers JSON**, pour
 > La base `data/remede-less.db` est une ancienne version, qui ne contient pas les champs `exemples`, `etymologies` et `rimes`. Elle est utilisée comme base **light**, pour les appareils avec peu de place.
 
 **Organisation d'une génération de données:**
+0. `pre_generate_ressources.py` génère les ressources nécessaires (`mots.txt` et `ipa.json`, depuis `IPA.txt`)
 1. `parse.py` génère un fichier JSON par lettre (plusieurs heures)
 2. `generate_sqlite.py` génère la base Sqlite, depuis les fichiers JSON (plusieurs dizaines de minutes)
 

diff --git a/api-definition b/api-definition
diff --git a/app/android/app/build.gradle b/app/android/app/build.gradle
@@ -7,8 +7,8 @@ android {
         applicationId "com.camarm.remede"
         minSdkVersion rootProject.ext.minSdkVersion
         targetSdkVersion rootProject.ext.targetSdkVersion
-        versionCode 1101
-        versionName '1.1.0-beta.1'
+        versionCode 1102
+        versionName '1.1.0-beta.2'
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         aaptOptions {
              // Files and dirs to omit from the packaged assets dir, modified to accommodate modern web apps.

diff --git a/app/android/app/release/output-metadata.json b/app/android/app/release/output-metadata.json
@@ -11,8 +11,8 @@
       "type": "SINGLE",
       "filters": [],
       "attributes": [],
-      "versionCode": 1100,
-      "versionName": "1.1.0-beta",
+      "versionCode": 1102,
+      "versionName": "1.1.0-beta.2",
       "outputFile": "app-release.apk"
     }
   ],

diff --git a/app/electron/package.json b/app/electron/package.json
@@ -1,6 +1,6 @@
 {
   "name": "remede",
-  "version": "1.1.0-beta.1",
+  "version": "1.1.0-beta.2",
   "description": "A french mobile and offline dictionary.",
   "build": {
     "appId": "com.camarm.remede",

diff --git a/app/package-lock.json b/app/package-lock.json
diff --git a/app/package.json b/app/package.json
@@ -1,7 +1,7 @@
 {
   "name": "remede",
   "private": true,
-  "version": "1.1.0-beta.1",
+  "version": "1.1.0-beta.2",
   "type": "module",
   "license": "Cecill V2.1",
   "author": {
@@ -38,6 +38,7 @@
     "install": "^0.13.0",
     "ionicons": "^7.0.0",
     "sql.js": "^1.8.0",
+    "swiper": "^11.0.5",
     "vue": "^3.2.45",
     "vue-router": "^4.1.6"
   },

diff --git a/app/src/App.vue b/app/src/App.vue
@@ -33,6 +33,12 @@
                   <ion-label>Fiches</ion-label>
                 </ion-item>
               </ion-menu-toggle>
+              <ion-menu-toggle :auto-hide="false">
+                <ion-item @click="goTo('/rimes')" lines="none" :detail="false" class="hydrated" :class="path === '/rimes' ? 'selected': ''">
+                  <ion-icon aria-hidden="true" slot="start" :icon="swapHorizontalOutline"></ion-icon>
+                  <ion-label>Rimes</ion-label>
+                </ion-item>
+              </ion-menu-toggle>
             </div>
             <div class="end">
               <ion-menu-toggle :auto-hide="false">
@@ -74,7 +80,7 @@ import {
 import {
   bookOutline,
   informationCircleOutline,
-  cogOutline, documentOutline, bookmarkOutline, medicalOutline
+  cogOutline, documentOutline, bookmarkOutline, medicalOutline, swapHorizontalOutline
 } from 'ionicons/icons';
 
 </script>

diff --git a/app/src/assets/closeQuote.svg b/app/src/assets/closeQuote.svg
diff --git a/app/src/assets/openQuote.svg b/app/src/assets/openQuote.svg
diff --git a/app/src/components/FicheModal.vue b/app/src/components/FicheModal.vue
@@ -145,7 +145,7 @@ export default defineComponent({
   }
 })
 </script>
-<style>
+<style scoped>
 .alert .alert-message {
   text-align: justify;
   color: var(--ion-color-medium);