Merge pull request #60 from techstartucalgary/dev

Dev

.github/workflows/ci.yml

@@ -7,6 +7,19 @@ on:
       - dev
 
 jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: cd backend && npm install
+
+      - name: Lint
+        run: cd backend && npm run lint
+
   build:
     runs-on: ubuntu-latest
 
@@ -19,3 +32,16 @@ jobs:
 
       - name: Build
         run: cd backend && npm run build
+
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Install dependencies
+        run: cd backend && npm install
+
+      - name: Test
+        run: cd backend && npm test

.gitignore

@@ -3,4 +3,5 @@ node_modules
 dist
 migrations
 .DS_Store
-.vscode
+.vscode
+coverage

README.md

@@ -34,7 +34,7 @@
 - [Anfaal]() - Backend Developer
 - [Ryan]() - Backend Developer
 - [Alison]() - Backend Developer
-  
+
 ## 👨‍💻 Tech Stack
 
 - Frontend
@@ -51,12 +51,12 @@
   ![Node.js](https://img.shields.io/badge/Node.js-339933.svg?style=for-the-badge&logo=nodedotjs&logoColor=white)
   ![Prisma](https://img.shields.io/badge/Prisma-5a67d8.svg?style=for-the-badge&logo=Prisma&logoColor=white)
   ![MySQL](https://img.shields.io/badge/MySQL-3e6e93.svg?style=for-the-badge&logo=MySQL&logoColor=white)
+  ![Zod](https://img.shields.io/badge/Zod-3E67B1.svg?style=for-the-badge&logo=Zod&logoColor=white)
 
 - Cloud
 
   ![PlanetScale](https://img.shields.io/badge/PlanetScale-000000.svg?style=for-the-badge&logo=PlanetScale&logoColor=white)
 
-
 ## 🚀 Backend Documentation
 
 All the code is located in the `backend/src` directory. The backend is written using [Node.js](https://nodejs.org/en/) and [Express](https://expressjs.com/).
@@ -187,39 +187,40 @@ datasource db {
 npx prisma db push
 ```
 
-
 # 🌟 Frontend Documentation
 
 The frontend is crafted for iOS platforms, utilizing Swift and SwiftUI. The code is primarily housed in the `Rethread` directory. This section details the setup, development practices, and testing for the frontend environment.
 
 ## 🏃 Quickstart
 
 1. **Clone the Repository**:
-    ```bash
-    git clone [email protected]:techstartucalgary/fashion.git
-    ```
+
+   ```bash
+   git clone [email protected]:techstartucalgary/fashion.git
+   ```
 
 2. **Navigate to the Frontend Directory**:
-    ```bash
-    cd Rethread
-    ```
+
+   ```bash
+   cd Rethread
+   ```
 
 3. **Open the Project in Xcode**:
-    Open the project file `.xcodeproj` in Xcode.
+   Open the project file `.xcodeproj` in Xcode.
 
 4. **Run the Application**:
-    Select an iOS simulator or connected device in Xcode and click 'Run'.
+   Select an iOS simulator or connected device in Xcode and click 'Run'.
 
 ## 🛠️ Setup and Installation
 
 1. **Install Xcode**:
-    Ensure you have Xcode installed on your macOS, available through the Mac App Store.
+   Ensure you have Xcode installed on your macOS, available through the Mac App Store.
 
 2. **Update Swift and SwiftUI**:
-    Ensure you have the latest version of Swift and SwiftUI installed, as they are crucial for frontend development.
+   Ensure you have the latest version of Swift and SwiftUI installed, as they are crucial for frontend development.
 
 3. **Verify the Installation**:
-    Open Xcode and check for Swift and SwiftUI updates in the preferences.
+   Open Xcode and check for Swift and SwiftUI updates in the preferences.
 
 4. **Minimum iOS Version**: This app is built for `iOS 16` and above.
 

backend/.eslintrc.json

@@ -0,0 +1,22 @@
+{
+    "env": {
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-unused-vars": "warn",
+        "@typescript-eslint/no-explicit-any": "warn"
+    }
+}

backend/.gitignore

@@ -1,3 +1,5 @@
 node_modules
 # Keep environment variables out of version control
 .env
+dist
+coverage

backend/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3"
+
+services:
+  mysql:
+    image: mysql
+    environment:
+      MYSQL_ROOT_PASSWORD: root
+      MYSQL_DATABASE: rethread
+    ports:
+      - "3306:3306"
+    volumes:
+      - mysql:/var/lib/mysql
+
+volumes:
+  mysql:

backend/jest.config.ts

@@ -0,0 +1,19 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  verbose: true,
+  globals: {
+    "ts-jest": {
+      tsconfig: "tsconfig.json",
+    },
+  },
+  testMatch: ["<rootDir>/dist/**/*.test.js"],
+  coverageReporters: ["html"],
+  collectCoverage: true,
+  collectCoverageFrom: ["<rootDir>/dist/src/**/*.js"],
+  coverageDirectory: "<rootDir>/coverage",
+};
+
+export default config;