Merge branch 'stable' into keycloak-auth

Pictalk-speech-made-easy · Mar 14, 2024 · 5f28157 · 5f28157
2 parents 3f8d8ad + 72f972f
commit 5f28157
Show file tree

Hide file tree

Showing 37 changed files with 757 additions and 564 deletions.
diff --git a/.github/workflows/cypress.2.yml b/.github/workflows/cypress.2.yml
@@ -14,12 +14,11 @@ jobs:
   install:
     runs-on: ubuntu-latest
     container:
-      image: cypress/browsers:node16.13.0-chrome95-ff94
+      image: cypress/browsers:node-16.18.1-chrome-110.0.5481.96-1-ff-109.0-edge-110.0.1587.41-1
       options: --user 1001
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
-
+        uses: actions/checkout@v4
       - name: Cypress install
         uses: cypress-io/github-action@v5
         with:
@@ -37,32 +36,11 @@ jobs:
           if-no-files-found: error
           path: dist
 
-  install-windows:
-    runs-on: windows-2019
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Cypress install
-        uses: cypress-io/github-action@v5
-        with:
-          runTests: false
-      # report machine parameters
-      - run: npx cypress info
-      - run: node -p 'os.cpus()'
-      - run: npm run generate
-
-      - name: Save dist folder
-        uses: actions/upload-artifact@v3
-        with:
-          name: dist
-          if-no-files-found: error
-          path: dist
   ui-chrome-tests:
     timeout-minutes: 15
     runs-on: ubuntu-latest
     container:
-      image: cypress/browsers:node16.13.0-chrome95-ff94
+      image: cypress/browsers:node-16.18.1-chrome-110.0.5481.96-1-ff-109.0-edge-110.0.1587.41-1
       options: --user 1001
     needs: install
     strategy:
@@ -76,7 +54,7 @@ jobs:
         containers: [1]
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Download the dist folders
         uses: actions/download-artifact@v3
@@ -119,7 +97,7 @@ jobs:
     timeout-minutes: 15
     runs-on: ubuntu-latest
     container:
-      image: cypress/browsers:node16.13.0-chrome95-ff94
+      image: cypress/browsers:node-16.18.1-chrome-110.0.5481.96-1-ff-109.0-edge-110.0.1587.41-1
       options: --user 1001
     needs: install
     strategy:
@@ -133,7 +111,7 @@ jobs:
         containers: [1]
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Download the dist folders
         uses: actions/download-artifact@v3
@@ -153,135 +131,6 @@ jobs:
           group: "UI - Chrome - Mobile"
           spec: cypress/e2e/**/*.cy.js
           config-file: cypress.config.js
-        env:
-          CYPRESS_PROJECT_ID: ${{ secrets.CYPRESS_PROJECT_ID }}
-          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
-          # Recommended: pass the GitHub token lets this action correctly
-          # determine the unique run id necessary to re-run the checks
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  ui-firefox-tests:
-    timeout-minutes: 15
-    runs-on: ubuntu-latest
-    container:
-      image: cypress/browsers:node16.13.0-chrome95-ff94
-      options: --user 1001
-    needs: install
-    strategy:
-      # when one test fails, DO NOT cancel the other
-      # containers, because this will kill Cypress processes
-      # leaving the Dashboard hanging ...
-      # https://github.com/cypress-io/github-action/issues/48
-      fail-fast: false
-      matrix:
-        # run copies of the current job in parallel
-        containers: [1]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Download the dist folders
-        uses: actions/download-artifact@v3
-        with:
-          name: dist
-          path: dist
-      - name: "UI Tests - Firefox"
-        uses: cypress-io/github-action@v5
-        with:
-          start: npm run start
-          wait-on: "http://localhost:3000"
-          wait-on-timeout: 120
-          browser: firefox
-          record: true
-          parallel: true
-          group: "UI - Firefox"
-          spec: cypress/e2e/**/*.cy.js
-          config-file: cypress.config.js
-        env:
-          CYPRESS_PROJECT_ID: ${{ secrets.CYPRESS_PROJECT_ID }}
-          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
-          # Recommended: pass the GitHub token lets this action correctly
-          # determine the unique run id necessary to re-run the checks
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  ui-firefox-mobile-tests:
-    timeout-minutes: 15
-    runs-on: ubuntu-latest
-    container:
-      image: cypress/browsers:node16.13.0-chrome95-ff94
-      options: --user 1001
-    needs: install
-    strategy:
-      # when one test fails, DO NOT cancel the other
-      # containers, because this will kill Cypress processes
-      # leaving the Dashboard hanging ...
-      # https://github.com/cypress-io/github-action/issues/48
-      fail-fast: false
-      matrix:
-        # run copies of the current job in parallel
-        containers: [1]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Download the dist folders
-        uses: actions/download-artifact@v3
-        with:
-          name: dist
-          path: dist
-      - name: "UI Tests - Firefox - Mobile"
-        uses: cypress-io/github-action@v5
-        with:
-          config: "viewportWidth=375,viewportHeight=667"
-          start: npm run start
-          wait-on: "http://localhost:3000"
-          wait-on-timeout: 120
-          browser: firefox
-          record: true
-          parallel: true
-          spec: cypress/e2e/**/*.cy.js
-          group: "UI - Firefox - Mobile"
-          config-file: cypress.config.js
-        env:
-          CYPRESS_PROJECT_ID: ${{ secrets.CYPRESS_PROJECT_ID }}
-          CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
-          # Recommended: pass the GitHub token lets this action correctly
-          # determine the unique run id necessary to re-run the checks
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-  ui-windows-tests:
-    timeout-minutes: 40
-    runs-on: windows-2019
-    needs: install-windows
-    strategy:
-      # when one test fails, DO NOT cancel the other
-      # containers, because this will kill Cypress processes
-      # leaving the Dashboard hanging ...
-      # https://github.com/cypress-io/github-action/issues/48
-      fail-fast: false
-      matrix:
-        # run copies of the current job in parallel
-        containers: [1]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: Download the dist folders
-        uses: actions/download-artifact@v3
-        with:
-          name: dist
-          path: dist
-      - name: "UI Tests - Electron - Windows"
-        uses: cypress-io/github-action@v5
-        with:
-          start: npm run start
-          wait-on: "http://localhost:3000"
-          wait-on-timeout: 120
-          record: true
-          parallel: true
-          group: "UI - Electron - Windows"
-          spec: cypress/e2e/**/*.cy.js
-          config-file: cypress.config.js
         env:
           CYPRESS_PROJECT_ID: ${{ secrets.CYPRESS_PROJECT_ID }}
           CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}

diff --git a/README.md b/README.md
@@ -3,37 +3,54 @@
 [![Netlify](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)](https://www.netlify.com)
 [![Netlify Status](https://api.netlify.com/api/v1/badges/4714cbe2-afae-4818-8829-478955883e93/deploy-status)](https://app.netlify.com/sites/cranky-keller-81f822/deploys)
 
-[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#pictalk)
-
-# ➤ Pictalk
-
-> PicTalk is all about
->  **pictograms** . It's purpose is to make the life of
->  **speech-disabled** persons
->  **easier**. My little brother, Pablo, has
->  the down syndrome. He **isn't able to speak** nor to
->  write. Luckily Pablo is into tablet and phones. Most
->  of the communication Pablo does comes from his device.
->  The greater part of the time he uses pictures of places
->  or **pictograms to express himself**. Currently there are
->  very limited apps that use pictograms to produce a
->  sentence out loud. These apps were rather **expensive or
->  not compatible** with almost all devices. So I decided,
->  with my limited knowledge of Web development to make an
->  app.
-
-[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#build-setup)
-
-## ➤ Build Setup
-
-```bash
-# ➤ install dependencies
-$ npm install
-# ➤ serve with hot reload at localhost:3000
-$ npm run dev
-# ➤ build for production and launch server
-$ npm run build
-$ npm run start
-# ➤ generate static project
-$ npm run generate
+# Pictalk
+
+## Overview
+
+Pictalk is an open-source application designed to assist individuals with speech impediments communicate effectively using pictograms and pictures. This Nuxt.js project aims to make communication accessible and inclusive for everyone.
+You can use the application for free at [www.pictalk.org](https://www.pictalk.org)
+
+## Features
+
+- Build custom pictogram collections
+- Real-time communication support
+- Cross-device compatibility
+- Community collaboration and sharing
+- Text-to-Speech (TTS) support
+
+## Getting Started
+
+### Prerequisites
+
+- Node.js (v14 or v16)
+- NPM
+
+### Installation
+
+1. Clone the repository:
+   ```sh
+   git clone [https://github.com/your-repo-link.git](https://github.com/Pictalk-speech-made-easy/pictalk-frontend.git)
+Navigate to the project directory and install dependencies:
+
+Copy code
+```sh
+cd pictalk
+npm install
+```
+
+Run the development server:
+```sh
+Copy code
+npm run dev
 ```
+## Contributing
+We encourage community contributions. Please feel free to submit issues, fork the repository, and send pull requests!
+
+## License
+This project is licensed under the GNU General Public License. See the LICENSE file for details.
+
+## Support
+This project is free to use and open-source because we believe communication is a fundamental right. If you find this project useful, please consider making a donation to support server costs and ongoing development. Thank you!
+
+## Contact
+For any inquiries or feedback, please contact [[email protected]](mailto:[email protected]).