Merge branch 'main' of github.com:UwUClub/AwARea

.github/workflows/back.yml

@@ -5,6 +5,7 @@ on:
         branches:
             - main
             - dev
+            - AW-42-documentation-tests-cicd
         paths:
             - "api/**"
     pull_request:

.github/workflows/deploy.yml

@@ -4,7 +4,6 @@ on:
     push:
         branches:
             - main
-            - AW-35-Tests-unitaires
 
 jobs:
     deploy:

.github/workflows/front.yml

@@ -5,6 +5,7 @@ on:
         branches:
             - main
             - dev
+            - AW-42-documentation-tests-cicd
         paths:
             - "flutter_area/**"
         tags:
@@ -35,8 +36,13 @@ jobs:
 
             - name: Build APK
               run: |
+                  touch .env
+                  echo GITHUB_CLIENT_ID='${{ secrets.GTHUB_CLIENT_ID }}' >> .env
+                  echo GITHUB_CLIENT_SECRET='${{ secrets.GTHUB_CLIENT_SECRET }}' >> .env
+                  cat .env
                   flutter build apk --release
                   mv build/app/outputs/flutter-apk/app-release.apk build/app/outputs/flutter-apk/maker.apk
+                  keytool -printcert -jarfile build/app/outputs/flutter-apk/maker.apk > build/app/outputs/flutter-apk/sha_key_google.txt
               working-directory: ./flutter_area
 
             - name: Upload APK
@@ -45,6 +51,12 @@ jobs:
                   name: maker.apk
                   path: ./flutter_area/build/app/outputs/flutter-apk/maker.apk
 
+            - name: Upload key
+              uses: actions/upload-artifact@v3.1.3
+              with:
+                  name: sha_key.txt
+                  path: ./flutter_area/build/app/outputs/flutter-apk/sha_key_google.txt
+
             - name: Publish Tagged Release
               uses: softprops/action-gh-release@v1
               if: ${{ startsWith(github.ref, 'refs/tags/') }}

README.md

@@ -8,25 +8,32 @@
 -   [Installation from source](#installation-from-source)
 -   [Using the application](#using-the-application)
 -   [Troubleshooting](#troubleshooting)
+-   [Documentation](#documentation)
 -   [Credits](#credits)
 -   [License](#license)
 
 ## Requirements
 
--   Node.js
--   Npm
--   Flutter
+| Language / Tools | Link | Description |
+|:---:|:---:|:---:|
+| [![My Skills](https://skillicons.dev/icons?i=docker)](Docker) | [**Docker**](https://www.docker.com/) | Docker is used to containerize the application, the api and the database. |
+| [![My Skills](https://skillicons.dev/icons?i=mongodb)](MongoDB) | [**MongoDB**](https://www.mongodb.com/) | MongoDB is used as the database for the application. (not mandatory if using Docker) |
+| [![My Skills](https://skillicons.dev/icons?i=nodejs)](NodeJS) | [**NodeJS**](https://nodejs.org/en/) | NodeJS is used to run the application. (not mandatory if using Docker) |
+| [![My Skills](https://skillicons.dev/icons?i=typescript)](TypeScript) | [**TypeScript**](https://www.typescriptlang.org/) | TypeScript is used to write the application. |
+| [![My Skills](https://skillicons.dev/icons?i=flutter)](Flutter) | [**Flutter**](https://flutter.dev/) | Flutter is used to write the mobile application. |
+| [![My Skills](https://skillicons.dev/icons?i=git)](Git) | [**Git**](https://git-scm.com/) | Git is used for version control. |
+---
 
 ## Communication
 
 -   If you have a bug or an issue, please contact us.
 
 ## Services
 
--   [x] Timer -> 2 actions -> Recurring / One time
--   [x] Weather -> 1 action -> OnGetWeather
--   [x] Nasa -> 1 action -> OnGetPicture
--   [x] GMail -> 2 actions -> OnNewMail / OnNewMailFrom / WriteMail
+-   [x] Timer
+-   [x] Weather
+-   [x] Nasa
+-   [x] GMail
 -   [x] Github
 -   [x] Slack
 
@@ -40,15 +47,24 @@ git clone git@github.com:UwUClub/AwArea.git
 
 ## Using the application
 
-### Server
+### Docker
+
+- use in the root directory
+```bash
+docker-compose up --build
+```
+
+### Manual
+
+#### Server
 
 First start the server
 
 ```bash
-cd api && npm install && npmstart
+cd api && npm install && npm start
 ```
 
-### Client
+#### Client
 
 Then start the client
 
@@ -66,13 +82,18 @@ rm {your_flutter_directory}/bin/cache/flutter_tools.stamp
 
 And add `'--disable-web-security'` under `'--disable-extensions'` in `{your_flutter_directory}/packages/flutter_tools/lib/src/web/chrome.dart`
 
+## Documentation
+
+-   [User documentation to use Slack](doc/user/HowToMakeSlackApp.md)
+-   [Developer](doc/developer/Introduction.md)
+
 ## Credits
 
 -   Valentin Gegoux
--   Baptiste Laran
 -   Quentin Challon
 -   Luca Deltort
 -   Maxence Labourel
+-   Baptiste Laran
 
 ## License
 

api/.eslintrc.js

@@ -6,10 +6,7 @@ module.exports = {
     sourceType: 'module',
   },
   plugins: ['@typescript-eslint/eslint-plugin'],
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
-  ],
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
   root: true,
   env: {
     node: true,

api/.prettierrc

@@ -1,6 +1,7 @@
 {
-    "singleQuote": true,
-    "trailingComma": "all",
-    "tabWidth": 4,
-    "max_line_length": 120
-}
+  "singleQuote": true,
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "max_line_length": 120,
+  "printWidth": 120
+}