-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into frontend-swift
Signed-off-by: Parsa Kargari <[email protected]>
- Loading branch information
Showing
49 changed files
with
6,250 additions
and
1,525 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| name: Continuous Integration | ||
|
|
||
| on: | ||
| pull_request: | ||
| branches: | ||
| - main | ||
| - 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 | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v3 | ||
|
|
||
| - name: Install dependencies | ||
| run: cd backend && npm install | ||
|
|
||
| - 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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 techstartucalgary | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,18 @@ | ||
| # ♻️ ReThread | ||
|
|
||
| [](https://github.com/techstartucalgary/fashion/actions/workflows/ci.yml) | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| ## 📖 Table of Contents | ||
|
|
||
| - [📝 Contributors](#-contributors) | ||
| - [👨💻 Teck Stack](#-tech-stack) | ||
| - [👨💻 Tech Stack](#-tech-stack) | ||
| - [🚀 Backend Documentation](#-backend-documentation) | ||
| - [🏃 Quickstart](#-quickstart) | ||
| - [🏃 Quick start](#-quick-start) | ||
| - [🛠️ Installation](#️-installation) | ||
| - [🧪 Testing](#-testing) | ||
| - [🚧 Development Environment](#-development-environment) | ||
|
|
@@ -27,45 +34,34 @@ | |
| - [Anfaal]() - Backend Developer | ||
| - [Ryan]() - Backend Developer | ||
| - [Alison]() - Backend Developer | ||
|
|
||
| ## 👨💻 Tech Stack | ||
|
|
||
| - Frontend | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| - Testing | ||
|
|
||
|  | ||
|  | ||
|
|
||
| - Backend | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
| - Testing | ||
|
|
||
|  | ||
|  | ||
|
|
||
| - CI/CD | ||
|  | ||
|  | ||
|  | ||
|  | ||
|
|
||
|  | ||
| - Cloud | ||
|
|
||
|  | ||
|
|
||
| ## 🚀 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/). | ||
|
|
||
| ### 🏃 Quickstart | ||
| ### 🏃 Quick start | ||
|
|
||
| 1. Open the terminal and clone this repository using HTTPS or SSH (The example below uses SSH). | ||
|
|
||
|
|
@@ -85,18 +81,6 @@ cd fashion | |
| cd backend | ||
| ``` | ||
|
|
||
| 4. Run `npm install --only=production` to install all the dependencies. | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 5. Run `npm run start` to start the server. | ||
|
|
||
| ```bash | ||
| npm run start | ||
| ``` | ||
|
|
||
| ### 🛠️ Installation | ||
|
|
||
| 1. Make sure you have `Node.js` and `NPM` installed on your machine. Click [here](https://nodejs.org/en/) to download and install Node.js. Make sure you install the LTS version. NPM is installed automatically when you install Node.js. | ||
|
|
@@ -115,25 +99,17 @@ npm -v | |
|
|
||
| 4. If you see the version number of `Node.js` and `npm` then you are good to go. If not, then try to reinstall `Node.js`. | ||
|
|
||
| 5. Make sure you have `MySQL` installed on your machine. Click [here](https://dev.mysql.com/downloads/mysql/) to download and install MySQL. Make sure you install the latest version. | ||
|
|
||
| 6. Open the terminal and run `mysql --version` to check if `MySQL` is installed. | ||
|
|
||
| ```bash | ||
| mysql --version | ||
| ``` | ||
| 5. Make sure you have `Docker Desktop` installed on your machine. Click [here](https://www.docker.com/products/docker-desktop) to download and install Docker Desktop. Make sure you install the latest version. | ||
|
|
||
| 7. If you see the version number of `MySQL` then you are good to go. If not, then try to reinstall `MySQL`. | ||
| 6. Make sure you have `Git` installed on your machine. Click [here](https://git-scm.com/downloads) to download and install Git. Make sure you install the latest version. | ||
|
|
||
| 8. Make sure you have `Redis` installed on your machine. Click [here](https://redis.io/download) to download and install Redis. Make sure you install the latest version. | ||
|
|
||
| 9. Open the terminal and run `redis-server --version` to check if `Redis` is installed. | ||
| 7. Open the terminal and run `git -v` to check if `Git` is installed. | ||
|
|
||
| ```bash | ||
| redis-server --version | ||
| git -v | ||
| ``` | ||
|
|
||
| 10. If you see the version number of `Redis` then you are good to go. If not, then try to reinstall `Redis`. | ||
| 8. If you see the version number of `Git` then you are good to go. If not, then try to reinstall `Git`. | ||
|
|
||
| ### 🧪 Testing | ||
|
|
||
|
|
@@ -189,18 +165,27 @@ cd backend | |
| npm install | ||
| ``` | ||
|
|
||
| 5. Run `npm run start` to start the server. | ||
| 5. Run `npx prisma init` to initialize the database. | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| npx prisma init | ||
| ``` | ||
|
|
||
| 6. Run `npx prisma studio` to open Prisma Studio and view the database schema (Optional). | ||
| 6. Update your `prisma/schema.prisma` file within the `backend` folder to use the `mysql` provider and set the relation mode type to `prisma`. | ||
|
|
||
| ```bash | ||
| npx prisma studio | ||
| ```prisma | ||
| datasource db { | ||
| provider = "mysql" | ||
| url = env("DATABASE_URL") | ||
| relationMode = "prisma" | ||
| } | ||
| ``` | ||
|
|
||
| 7. Once you are ready to push your schema to PlanetScale, run `prisma db push` against your PlanetScale database to update the schema in your database. | ||
|
|
||
| ```bash | ||
| npx prisma db push | ||
| ``` | ||
|
|
||
| # 🌟 Frontend Documentation | ||
|
|
||
|
|
@@ -209,31 +194,33 @@ The frontend is crafted for iOS platforms, utilizing Swift and SwiftUI. The code | |
| ## 🏃 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. | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" | ||
| } | ||
| } |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| node_modules | ||
| # Keep environment variables out of version control | ||
| .env | ||
| dist | ||
| coverage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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; |
Oops, something went wrong.