Merge pull request #64 from WildCodeSchool/staging

Staging

.dockerignore

@@ -0,0 +1,6 @@
+**/dist
+*.log
+*.md
+.git
+build/
+**/node_modules

.env.sample

@@ -1,3 +1,28 @@
+## Client
+
+# if VITE_NODE_ENV === production,
+# AuthGuard is on
+VITE_NODE_ENV="dev"
+
+# Server location change to /graphql in staging or prod 
+VITE_API_URL="http://localhost:3200"
+
+## Server 
+
 DBNAME=YOUR_DBNAME
 DBUSERNAME=YOUR_DBUSERNAME
-DBPASS=YOUR_DB_PASS
+DBPASS=YOUR_DB_PASS
+
+# URL
+FRONTEND_URL="http://localhost:4200"
+
+#  smtp 
+SMTP_HOST=""
+SMTP_PORT= 
+SMTP_USER=''
+SMTP_PASS=''
+
+# change emailservices initialization when this value === "production"
+NODE_ENV="dev"
+
+JWTSECRETKEY="JWTSECRETKEY"

.github/workflows/prod-client.yml

@@ -0,0 +1,54 @@
+name: Compile and push client image
+
+
+on:
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+
+jobs:
+
+
+  build:
+
+
+    runs-on: ubuntu-latest
+
+
+    steps:
+
+      - uses: actions/checkout@v4
+
+      # login with Docker
+
+      - uses: docker/login-action@v3
+        name: Login to Docker Hub
+
+        with:
+
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+
+
+      # prepare buildx for docker
+
+      - uses: docker/setup-buildx-action@v3
+        name: Set up Docker Buildx
+
+
+      # build and push the newly created image
+
+      - uses: docker/build-push-action@v5
+        name: Build and push
+
+        with:
+
+          context: ./client
+          file: ./client/Dockerfile
+          push: true
+
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/prod_client_pawplanner:latest

.github/workflows/prod-server.yml

@@ -0,0 +1,54 @@
+name: Compile and push server image
+
+
+on:
+
+
+  push:
+    branches: ["main"]
+
+
+  workflow_dispatch:
+
+
+jobs:
+
+  build:
+
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - uses: actions/checkout@v4
+
+
+      # login with Docker
+
+      - uses: docker/login-action@v3
+        name: Login to Docker Hub
+
+        with:
+
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+
+
+      # prepare buildx for docker
+
+      - uses: docker/setup-buildx-action@v3
+        name: Set up Docker Buildx
+
+
+      # build and push the newly created image
+
+      - uses: docker/build-push-action@v5
+        name: Build and push
+
+        with:
+
+          context: ./server
+          file: ./server/Dockerfile
+          push: true
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/prod_server_pawplanner:latest

.github/workflows/staging-client.yml

@@ -0,0 +1,54 @@
+name: Compile and push client image
+
+
+on:
+  push:
+    branches: ["staging"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+
+jobs:
+
+
+  build:
+
+
+    runs-on: ubuntu-latest
+
+
+    steps:
+
+      - uses: actions/checkout@v4
+
+      # login with Docker
+
+      - uses: docker/login-action@v3
+        name: Login to Docker Hub
+
+        with:
+
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+
+
+      # prepare buildx for docker
+
+      - uses: docker/setup-buildx-action@v3
+        name: Set up Docker Buildx
+
+
+      # build and push the newly created image
+
+      - uses: docker/build-push-action@v5
+        name: Build and push
+
+        with:
+
+          context: ./client
+          file: ./client/Dockerfile
+          push: true
+
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/staging_client_pawplanner:latest

.github/workflows/staging-server.yml

@@ -0,0 +1,54 @@
+name: Compile and push server image
+
+
+on:
+
+
+  push:
+    branches: ["staging"]
+
+
+  workflow_dispatch:
+
+
+jobs:
+
+  build:
+
+
+    runs-on: ubuntu-latest
+
+    steps:
+
+      - uses: actions/checkout@v4
+
+
+      # login with Docker
+
+      - uses: docker/login-action@v3
+        name: Login to Docker Hub
+
+        with:
+
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+
+
+      # prepare buildx for docker
+
+      - uses: docker/setup-buildx-action@v3
+        name: Set up Docker Buildx
+
+
+      # build and push the newly created image
+
+      - uses: docker/build-push-action@v5
+        name: Build and push
+
+        with:
+
+          context: ./server
+          file: ./server/Dockerfile
+          push: true
+          tags: ${{ secrets.DOCKER_HUB_USERNAME }}/staging_server_pawplanner:latest

.gitignore

@@ -25,4 +25,7 @@ dist-ssr
 **/.env
 .env
 */node_modules
-/db_data
+/db_data
+
+# Upload 
+**server/upload

.husky/pre-commit

@@ -0,0 +1,5 @@
+npm run check-format || {
+  echo "🚨 Your code is not properly formatted. Please run 'npm run format' in the root directory to fix the formatting."
+  echo "Once formatted, you will need to run 'git add' again before committing."
+  exit 1
+}

README.md

@@ -23,10 +23,12 @@ ___
     - **Apollo Server**
     - **TypeGraphQL**
     - **PostegreSQL**
+    - **Jest**
 - Client side:
     - **React** (through ViteJS)
     - **Apollo Client** (via Vite)
     - **Sass**
+    - **Vitest**
 
 ## Launch
 
@@ -39,6 +41,13 @@ ___
 2. **Any other launch**
     - Run `docker compose up`
 
+Every new dependency asks for a rebuild (`npm run ci:all`, `docker compose down` then `docker compose up --build`).
+
+**Client**: http://localhost:4200/ </br>
+**Server**: http://localhost:3200/
+
+**Adminer**: http://localhost:8080/
+
 ### Explanations
 
 First of all, copy and edit the `.env.sample` in a `.env` file. <br>
@@ -48,14 +57,16 @@ Then run `npm run install:all` to run the `npm install` commands in the /root, /
 
 On first launch, create your PostgreSQL user, either inside your container (run `npm run init:db`, it works as explained in [this documentation](./_ressources/documentation/Database_initialization.md)) or through a PostgreSQL user interface such as **pgAdmin**.
 
-You can verify if your user has been created through **adminer** (Système: PostgreSQL | Serveur: db | Utilisateur: $DBUSERNAME | Mot de passe: $DBPASS | Base de données: $DBNAME).
+You can verify if your user has been created through **adminer** (Système: PostgreSQL | Serveur: db | Utilisateur: $DBUSERNAME | Mot de passe: $DBPASS | Base de données: $DBNAME - replace the variables).
 
 Run `docker compose up`.
 
 Isolated basic commands for debugging purpose: 
 - client side: `npm run dev`
 - server side: `npm start`
 
+// FIXME: add doc design pattern
+
 ### Folder Structure
 
 ```lua (aesthetic use, not actual lua)
@@ -68,12 +79,14 @@ PawPlanner/
 ├── client/                     -- FRONTEND
 │   ├── public/
 |   ├── src/
+|   │   ├── __tests__/
+|   │   |   └── ...
 |   │   ├── assets/
 |   │   ├── components/
 |   │   |   ├── _atoms/
 |   │   |   ├── _molecules/
 |   │   |   ├── _organisms/
-|   │   |   └── ComponentName/  -- TODO: sort and clean
+|   │   |   └── ComponentName/
 |   |   │       ├── ComponentName.tsx
 |   |   │       └── ComponentName.scss
 |   │   ├── graphQL/
@@ -101,6 +114,8 @@ PawPlanner/
 |   └── -- Other client side config files
 ├── server/                     -- BACKEND
 |   ├── src/
+|   │   ├── __tests__/
+|   │   |   └── ...
 |   │   ├── dataSource/
 |   │   |   ├── dataSource.ts
 |   │   |   └── initTestData.ts

_ressources/conception_ressources/SequenceDiagrams.md

@@ -7,6 +7,7 @@
 1. [Registration Sequence](#registration-sequence)
 2. [Login Sequence](#login-sequence)
 3. [Logout Sequence](#logout-sequence)
+4. [Forgot password](#forgot-password-sequence)
 
 ### Visitor functions
 
@@ -40,6 +41,13 @@
 
 ![UML Diagram Use Case of PawPlanner](./assets/sequences/logout.svg)
 
+
+## Forgot Password Sequence
+
+[Back to Top](#table-of-contents)
+
+![UML Diagram Use Case of PawPlanner](./assets/sequences/ForgotPassword.svg)
+
 ---
 ---
 

_ressources/scripts/init_db_user.ts

@@ -1,4 +1,4 @@
-import { exec } from 'child_process';
+import { exec } from 'node:child_process';
 import dotenv from 'dotenv';
 dotenv.config();
 

biome.json

@@ -19,6 +19,9 @@
 		"quoteProperties": "asNeeded",
 		"semicolons": "always",
 		"trailingCommas": "all"
+	  },
+	  "parser": {
+		"unsafeParameterDecoratorsEnabled": true
 	  }
 	},
 	"organizeImports": { "enabled": true },

client-package.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+docker compose exec client /bin/bash -c "npm install $*"