UofT-UTSC-CS-sandbox · github-classroom · May 30, 2024 · May 30, 2024 · May 30, 2024 · May 30, 2024
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,5 @@
+**/.DS_Store
+.vscode
+node_modules/
+.prettierrc
+pactify-server/config.env
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,5 @@
+{
+    "githubPullRequests.ignoredPullRequestBranches": [
+        "main"
+    ]
+}
diff --git a/CICD/.gitlab-ci.yml b/CICD/.gitlab-ci.yml
@@ -0,0 +1,48 @@
+stages:
+  - build
+  - deploy
+  - test
+
+build-docker:
+  image: docker:latest
+  stage: build
+
+  services:
+    - docker:dind
+
+  variables:
+    DOCKER_HOST: tcp://docker:2375/
+    DOCKER_TLS_CERTDIR: ""
+
+  before_script:
+    - apk update
+    - apk add --no-cache docker-cli
+
+  script:
+    - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
+    - docker build -t $DOCKER_USERNAME/pactify:latest -t $DOCKER_USERNAME/pactify:v1.0.0 .
+    - docker push $DOCKER_USERNAME/pactify:latest
+    - docker push $DOCKER_USERNAME/pactify:v1.0.0
+
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "main"'
+
+deploy-and-test:
+  image: docker/compose:latest
+  stage: deploy
+
+  services:
+    - docker:dind
+
+  variables:
+    DOCKER_HOST: tcp://docker:2375/
+    DOCKER_TLS_CERTDIR: ""
+
+  before_script:
+    - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
+
+  script:
+    - docker-compose up --abort-on-container-exit --exit-code-from tester
+
+  rules:
+    - if: '$CI_COMMIT_BRANCH == "main"'
diff --git a/CICD/A2 Submission Details.pdf b/CICD/A2 Submission Details.pdf
diff --git a/CICD/A2 System Design Document.pdf b/CICD/A2 System Design Document.pdf
diff --git a/CICD/A2README.md b/CICD/A2README.md
@@ -0,0 +1,27 @@
+# Pactify CI/CD Pipeline
+
+## Overview
+
+This project sets up a CI/CD pipeline for our application using Docker, Docker Compose, and GitLab CI/CD.
+
+## Files and Directories
+
+- **Dockerfile**: Defines the steps to build the Docker image for the application.
+- **docker-compose.yml**: Defines the services required for the application.
+- **.gitlab-ci.yml**: Definess the CI/CD pipeline stages and jobs.
+- **/reports**: Contains all the system design and workflow implementation docs.
+
+## How to Run
+
+1. First ensure Docker and Docker Compose are installed.
+2. Then clone the repository.
+3. Then you want to navigate to the project directory.
+4. Then just run `docker-compose up` to start the services.
+5. Finally, access the application at `http://localhost:5001`. I can't use port 5000 since Control Center in macOS Monterey listens on it... refer to: [Port 5000 used by Control Center in macOS Control Center](https://nono.ma/port-5000-used-by-control-center-in-macos-controlce).
+
+## CI/CD Pipeline
+
+The CI/CD pipeline is defined in `.gitlab-ci.yml` and includes the following stages:
+- **Build**: Builds the Docker image for the application.
+- **Deploy**: Deploys the application using Docker Compose.
+- **Test**: Verifies the application is running correctly.
diff --git a/CICD/Dockerfile b/CICD/Dockerfile
@@ -0,0 +1,27 @@
+# Build client
+FROM node:16 AS client-build
+WORKDIR /app
+COPY pactify-app/package*.json ./
+RUN npm install
+COPY pactify-app/ ./
+RUN npm run build
+
+# Build server
+FROM node:16 AS server-build
+WORKDIR /app
+COPY pactify-server/package*.json ./
+RUN npm install
+COPY pactify-server/ ./
+
+# Copy the client build to the server's public directory
+COPY --from=client-build /app/build /app/public
+
+# MaKing Sure the entire project is copied
+COPY pactify-server/models /app/models
+COPY pactify-server/routes /app/routes
+
+
+EXPOSE 5000
+
+
+CMD ["node", "server.js"]
diff --git a/CICD/a2_mark.md b/CICD/a2_mark.md
@@ -0,0 +1,50 @@
+# Assignment 2 Marking Scheme 50 marks
+
+**Team Name:** Algoholics
+
+---
+## System Design (PDF or MD file or another suitable format) (max 15 marks)
+
+  - Software Architecture Diagram & CI Workflow(max 10 marks)
+    - 10 marks = The Architecture Diagram is present, it is formatted using proper graphic symbols. CI workflow is set up using GitAction with proper comments
+    -  5 marks = The Architecture Diagram is present, it is not formatted well. CI workflow is set up but with no proper comments.
+    -  0 marks = No diagram present or the presented document does not look like a software architecture diagram. No CI workflow set up.
+
+    Your Mark: 10
+
+  - Tasks Distribution (max 5 marks)
+    - 5 marks  = every team member had at least one task assigned and completed
+    - 4 marks  = every team member had at least one task assigned and made a pull request
+    - 2 marks  = at least one team member did not complete any task or did not have any task assigned
+    - 0 marks  = most of team members have no tasks assigned and/or completed
+
+    Your Mark: 5
+
+
+## GitHub Review (Max 30 marks) 
+
+
+  - Working CICD pipeline (X marks)
+    - 5 marks  = docker file(s) that that can meet all the project requirements and features
+    - 5 marks  = build docker image
+    - 5 marks  = Push Docker image to a container registry (e.g. DockerHub)
+    - 5 marks  = 3-5 Test Cases written for CI or CD
+    - 10 marks = Deployment of container image(s) on an orchestration framework (e.g. kubernetes) 
+
+    Your Mark: 27
+
+    Not enough test cases
+
+  - Documentation (max 5 marks)
+
+  - 5 marks = documentation has been created for all steps
+  - 3 mark = documentation has been created for some steps
+  - 0 marks = documentation has not been created
+
+    Your Mark: 5
+
+
+
+## Total Mark
+
+47 / 50
diff --git a/CICD/docker-compose.yml b/CICD/docker-compose.yml
@@ -0,0 +1,20 @@
+version: '3'
+services:
+  mongo:
+    image: mongo:latest
+    ports:
+      - "27017:27017"
+
+  pactify:
+    image: haha0224/pactify:latest
+    ports:
+      - "5001:5000"
+    environment:
+      - NODE_ENV=production
+      - MONGO_URI=mongodb://mongo:27017/Pactify
+
+  tester:
+    image: alpine:latest
+    depends_on:
+      - pactify
+    entrypoint: ["sh", "-c", "apk add --no-cache curl && sleep 60 && curl -f http://pactify:5000 || true"]
diff --git a/CICD/test.sh b/CICD/test.sh
@@ -0,0 +1,15 @@
+#!/bin/sh
+
+# Increase the wait time to ensure the service is up and running
+sleep 60
+
+# Check if the service is listening 
+netstat -tuln
+
+# Check if the service is up
+curl -f http://localhost:5000 || {
+  echo "Service is not running or not accessible"
+  exit 1
+}
+
+echo "Container is running and accessible"
diff --git a/Interface/AccountInfo.png b/Interface/AccountInfo.png
diff --git a/Interface/FinalEdits.png b/Interface/FinalEdits.png
diff --git a/Interface/Generate.png b/Interface/Generate.png
diff --git a/Interface/HomeScreen.png b/Interface/HomeScreen.png
diff --git a/Interface/Login.png b/Interface/Login.png
diff --git a/Interface/ResetPassword-Email.png b/Interface/ResetPassword-Email.png
diff --git a/Interface/ResetPassword-NewPassword.png b/Interface/ResetPassword-NewPassword.png
diff --git a/Interface/Select.png b/Interface/Select.png
diff --git a/Interface/SignUp.png b/Interface/SignUp.png
diff --git a/Interface/UploadPDF.png b/Interface/UploadPDF.png
diff --git a/README.md b/README.md
@@ -0,0 +1,132 @@
+# Pactify
+
+Welcome to **Pactify**, a quick, easy, and affordable way to generate a contract, or update an existing contract. With our AI-powered contract generation, users can choose from one of our predefined templates or upload their own PDF, give us some additional information, and **Pactify** will do the rest. After generating your contract, you can freely edit, download, share, and save your contract to your account.
+
+## Running the app
+
+Instructions to run the app
+
+1. Acquire the config.env file and place it in the pactify-server directory
+
+2. In a shell, run the following:
+   ```bash
+
+    cd pactify-server
+
+    npm install
+
+    npm start
+
+    cd ..
+
+    cd pactify-app
+
+    npm install
+
+    npm start
+   ```
+
+## Getting Started
+
+![Image of the Pactify Landing Page](https://github.com/UofT-UTSC-CS-sandbox/final-term-project-the-algoholics/blob/develop/Interface/Login.png)
+
+##### The Pactify Login Screen
+
+To get started, all you have to do is go to our website and sign up. After signing up, you can freely use **Pactify** for all your contract generation needs, or go for **Pactify Premium** to gain some additional features!
+
+## Creating a New Contract
+
+![Image of Creating a New Contract](https://github.com/UofT-UTSC-CS-sandbox/final-term-project-the-algoholics/blob/develop/Interface/Generate.png)
+
+##### The Contract Creation Screen
+
+![Image of Uploading a PDF](https://github.com/UofT-UTSC-CS-sandbox/final-term-project-the-algoholics/blob/759dcaed133f9196e12468d39f722ec1cfa80b79/Interface/UploadPDF.png)
+
+##### The PDF Upload Screen
+
+To create a contract, first log in to **Pactify**. Once you're logged in, simply click on the "Create New" button. From there, choose whether you want to create an all new contract or upload your existing contract!
+
+## Updating an Existing Contract
+
+![Image of Editing Contract](https://github.com/UofT-UTSC-CS-sandbox/final-term-project-the-algoholics/blob/759dcaed133f9196e12468d39f722ec1cfa80b79/Interface/FinalEdits.png)
+
+##### The View/Edit Contract Screen
+
+To update a contract, first log in to **Pactify**. Once you're logged in, simply click on the contract you'd like to edit. From there, edit however you want, then save or download!
+
+## Deleting a Contract
+
+![Image of Home Screen](https://github.com/UofT-UTSC-CS-sandbox/final-term-project-the-algoholics/blob/759dcaed133f9196e12468d39f722ec1cfa80b79/Interface/HomeScreen.png)
+
+##### The Home Screen
+
+To delete a contract, first log in to **Pactify**. Once you're logged in, simply click "Delete" icon on the contract you'd like to delete.
+
+## Editing your Account
+
+![Image of Account Screen](https://github.com/UofT-UTSC-CS-sandbox/final-term-project-the-algoholics/blob/develop/Interface/AccountInfo.png)
+
+##### The Account Screen
+
+To edit your account, first log in to **Pactify**. Once you're logged in, simply click your profile in the top right and then click the edit symbol on whatever you'd like to edit.
+
+## Deleting your Account
+
+![Image of Account Screen](https://github.com/UofT-UTSC-CS-sandbox/final-term-project-the-algoholics/blob/develop/Interface/AccountInfo.png)
+
+##### The Account Screen
+
+To delete your account, first log in to **Pactify**. Once you're logged in, simply click your profile in the top right and then click "Delete Account" You will then be prompted with a popup to confirm your choice. Thanks for using **Pactify**!
+
+# Contributing to Pactify 
+
+### 1. Do you use git flow?
+
+Yes, we use Git Flow for managing our branches and releases! In short, Git Flow should allow us to structure our workflow and maintain a clean, organized history of our codebase. Here’s a quick overview of our branching strategy:
+
+Main: The main branch **ONLY** contains production-ready code. **ONLY** thoroughly tested and stable code is merged here.
+
+Develop: The develop branch contains the latest delivered development changes for the next release. It’s where integration of features will occur.
+
+Feature Branches: Feature branches are created from develop and used to work on new features. Only once the feature is complete and tested, it’s merged back into develop.
+
+### 2. What do you name your branches?
+
+We will be following a clear and descriptive naming conventions for our branches to make it easier to understand the purpose of each branch. The conventions we shall be following are as follows:
+
+Feature Branches: 'feature/short-description'
+
+Release Branches: 'release/version-number'
+
+### 3. Do you use github issues or another ticketing website?
+
+We will be using Jira for tracking tasks, bugs, and feature requests. Each issue is labeled appropriately and assigned to team members. Our labels include:
+
+_bug_: For bug reports.
+
+_enhancement_: For new features or improvements.
+
+_documentation_: For documentation-related tasks.
+
+_question_: For questions or clarifications.
+
+_help wanted_: For tasks where we need additional input or help.
+
+### 4. Do you use pull requests?
+
+We will try to follow this pull request workflow: 
+
+Create a Branch: Start by creating a new branch based on the task or feature you are working on.
+
+Develop and Test: Implement your changes and **thoroughly** test said changes. 
+
+Open a Pull Request: Once the changes are ready, open a pull request against the develop branch. And then provide a clear and descriptive title and description of the changes you have made.
+
+Code Review: Team members will review the code you wrote. And then provide feedback, and request changes if necessary.
+
+Merge: After two members from the group approve the changes they are then merged into the develop branch. If it’s a hotfix, it will be merged into the main branch after the **entire** group approves the request.
+
+Hopefully, by following these steps, we ensure that our project remains organized, collaborative, and of high quality.
+
+
+