Added Authentication and User creation

.dockerignore

@@ -10,7 +10,6 @@ cypress
 
 # Exclude configuration files
 .dockerignore
-.env
 .eslint*
 .gitignore
 .lintstagedrc.js
@@ -25,3 +24,7 @@ docs
 *.md
 
 npm-debug.log
+
+# Environment variables
+.env
+.env*.local

.eslintignore

@@ -33,3 +33,7 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# docs
+docs/**/*
+*.md

.github/workflows/lint.yml

@@ -11,6 +11,10 @@ jobs:
               with:
                   node-version: '18.18.0'
             - run: npm ci
+            - name: Write environment variables
+              run: |
+                  echo "${{ secrets.ENV_TEST_LOCAL }}" > .env
+                  echo "" > cypress.config.json
             - name: ESLint
               run: npm run lint
             - name: Prettier

.github/workflows/preview_tests.yml

@@ -0,0 +1,47 @@
+name: Cypress Tests
+
+on:
+    push:
+        branches-ignore:
+            - main
+        paths-ignore:
+            - docs/**
+            - README.md
+jobs:
+    cypress-run:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Wait for preview deployment
+              uses: lewagon/[email protected]
+              with:
+                  ref: ${{ github.ref }}
+                  check-name: 'Deploy Preview'
+                  repo-token: ${{ secrets.PERSONAL_GITHUB_ACCESS_TOKEN }}
+                  wait-interval: 10
+            - name: Checkout
+              uses: actions/checkout@v4
+            - name: Write environment variables
+              run: |
+                  echo "${{ secrets.ENV_TEST_LOCAL }}" > .env
+                  echo "" > cypress.config.json
+            - name: Migrate Database
+              run: npx prisma migrate dev
+            - name: Cypress Run Component Tests
+              uses: cypress-io/github-action@v6
+              env:
+                  CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+                  GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_ACCESS_TOKEN }}
+              with:
+                  browser: chrome
+                  component: true
+                  wait-on: ${{ secrets.CYPRESS_BASE_URL }}
+            - name: Cypress Run E2E Tests
+              uses: cypress-io/github-action@v6
+              env:
+                  CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
+                  GITHUB_TOKEN: ${{ secrets.PERSONAL_GITHUB_ACCESS_TOKEN }}
+              with:
+                  install: false
+                  wait-on: ${{ secrets.CYPRESS_BASE_URL }}
+                  browser: chrome
+                  record: true

.github/workflows/vercel_preview_deployment.yml

@@ -0,0 +1,33 @@
+name: Vercel Preview Deployment .
+
+env:
+    VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
+    VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
+
+on:
+    push:
+        branches-ignore:
+            - main
+        paths-ignore:
+            - docs/**
+            - README.md
+
+jobs:
+    deploy-preview:
+        name: Deploy Preview
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - name: Install Vercel CLI
+              run: npm install --global vercel@latest
+            - name: Pull Vercel Environment Information
+              run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }}
+            - name: Write .env
+              run: |
+                  echo "${{ secrets.ENV_PREVIEW }}" > .env
+            - name: Build Project Artifacts
+              run: vercel build --token=${{ secrets.VERCEL_TOKEN }}
+            - name: Deploy Project Artifacts to Vercel
+              run: |
+                  url="$(vercel deploy --prebuilt --token=${{ secrets.VERCEL_TOKEN }})"
+                  vercel alias --token=${{ secrets.VERCEL_TOKEN }} set "$url" ubco-capstone-team-3.vercel.app

.prettierignore

@@ -33,3 +33,7 @@ yarn-error.log*
 # typescript
 *.tsbuildinfo
 next-env.d.ts
+
+# docs
+docs/**/*
+*.md

Dockerfile.dev

@@ -0,0 +1,28 @@
+FROM node:18-alpine
+
+WORKDIR /app
+
+COPY package*.json ./
+
+COPY prisma ./prisma
+
+ARG $ARG_DATABASE_URL
+ENV DATABASE_URL $ARG_DATABASE_URL
+ARG $ARG_NEXTAUTH_URL
+ENV NEXTAUTH_URL $ARG_NEXTAUTH_URL
+
+RUN npm install
+
+COPY . .
+
+RUN rm -rf prisma
+
+RUN mkdir -p .next
+RUN chown node:node . node_modules .next
+RUN chown -R node:node node_modules/.prisma
+
+USER node
+
+EXPOSE 3000
+
+CMD ["npm", "run", "dev"]

README.md

@@ -10,54 +10,19 @@
 
 ## Project Setup
 
-First, run the development server:
-
 ### Requirements
 
 -   [NodeJS 18.18](https://nodejs.org/en)
 -   [Docker Desktop](https://www.docker.com/products/docker-desktop/)
 
-### Installing Dependencies
-
-Run the following command to install dependencies
-
-```bash
-npm install
-```
-
-### Running the Project and the Database
-
-Run the following to start the project and run the dev database
-
-```bash
-docker-compose -f dev-docker-compose.yml up -d
-```
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+### Step-by-step guide
 
-### Linting the Project
+-   [Local Development Setup](docs/guides/local_development_setup.md)
+-   [Local Docker Development Setup](docs/guides/local_docker_development_setup.md)
 
-Run the following to lint and format the project
+### Common commands
 
-```bash
-npm run lint
-```
-
-### Testing the Project
-
-Run the following to open Cypress
-
-```bash
-cypress open
-```
-
-### Development environment variable
-
-Add this following code to a `.env` file
-
-```dotenv
-DATABASE_URL="postgresql://postgres:password123@localhost:5432/postgres?schema=dev"
-```
+-   [Common commands](docs/guides/commands.md)
 
 ## Chosen Project
 

cypress.config.ts

@@ -1,12 +1,19 @@
 import { defineConfig } from 'cypress'
+import clearDB from './cypress/tasks/clearDB'
 
 require('dotenv').config()
+
 export default defineConfig({
     e2e: {
-        baseUrl: process.env.NEXT_PUBLIC_BASE_URL,
+        projectId: process.env.CYPRESS_PROJECT_ID,
+        baseUrl: process.env.CYPRESS_BASE_URL,
         setupNodeEvents(on, config) {
             // implement node event listeners here
+            on('task', {
+                clearDB,
+            })
         },
+        experimentalModifyObstructiveThirdPartyCode: true,
     },
 
     component: {

cypress/component/demo-component.cy.tsx

@@ -5,11 +5,11 @@ describe('Demo Component', () => {
     it('Default Message', () => {
         cy.mount(<Demo />)
         cy.get('#message').should('have.text', 'Hello World! Good Morning')
-        cy.get('#date').should('have.text', "Today's date is: " + dateNow)
+        cy.get('#date').should('have.text', 'Today\'s date is: ' + dateNow)
     })
     it('Good Evening Message', () => {
         cy.mount(<Demo greetings='Good Evening' />)
         cy.get('#message').should('have.text', 'Hello World! Good Evening')
-        cy.get('#date').should('have.text', "Today's date is: " + dateNow)
+        cy.get('#date').should('have.text', 'Today\'s date is: ' + dateNow)
     })
 })

cypress/e2e/app/signin.cy.ts

@@ -0,0 +1,37 @@
+import { TIMEOUT } from '../../utils/constants'
+
+describe('Test auth', () => {
+    before(() => {
+        cy.task('clearDB')
+        cy.intercept(
+            {
+                method: 'GET',
+                url: 'https://accounts.google.com/o/oauth2/v2/auth?*',
+            },
+            (req) => {
+                const redirectUri = req.query['redirect_uri'] as string
+                const state = req.query['state'] as string
+                const code = req.query['code'] as string
+                const scope = req.query['scope'] as string
+                const authuser = req.query['authuser'] as number
+                const prompt = req.query['prompt'] as string
+                const url = `${ redirectUri }?code=${ code }&state=${ state }&scope=${ scope }&authuser=${ authuser }&prompt=${ prompt }`
+                req.redirect(url, 302)
+            }
+        ).as('googleSignIn')
+        cy.intercept('/api/auth/callback/google?*', (req) => {
+            req.redirect('/', 302)
+        }).as('googleSignInCallback')
+    })
+    it('should log in with google', () => {
+        cy.visit('/')
+        cy.get('[data-cy="login-button"]').click()
+
+        cy.get('h1').should('include.text', 'Sign In Page')
+        cy.get('[data-cy="google-sign-in-btn"]').should('include.text', 'Sign in with Google').click()
+        cy.wait(['@googleSignInCallback'], { timeout: TIMEOUT.EXTRA_LONG })
+
+        cy.location('origin', { timeout: TIMEOUT.EXTRA_LONG }).should('eq', Cypress.config().baseUrl)
+        cy.location('pathname').should('eq', '/')
+    })
+})

cypress/tasks/clearDB.ts

@@ -0,0 +1,8 @@
+import prisma from '@/lib/prisma'
+
+export default async function clearDB() {
+    await prisma.account.deleteMany({})
+    await prisma.user.deleteMany({})
+
+    return null
+}

cypress/utils/constants.ts

@@ -0,0 +1,15 @@
+export const TIMEOUT = {
+    EXTRA_SHORT: 500,
+    SHORT: 1000,
+    MEDIUM: 3000,
+    LONG: 6000,
+    EXTRA_LONG: 8000,
+}
+
+export const DELAY = {
+    EXTRA_SHORT: 500,
+    SHORT: 1000,
+    MEDIUM: 3000,
+    LONG: 6000,
+    EXTRA_LONG: 8000,
+}