Test if the CI/CD pipeline works

.env.template

@@ -1,16 +1,16 @@
-# ".env.template" is not actually used anywhere. It is just to show the format of an appropriate environment file
-DATABASE_URL=postgres://<username>:<password>@<hostname>:5432/bt
-DJANGO_SECRET_KEY=
-ENVIRONMENT_NAME=localhost
-GOOGLE_APPLICATION_CREDENTIALS_FILE_CONTENTS_BASE64=
-GOOGLE_APPLICATION_CREDENTIALS_FILEPATH=/auth.json
-GOOGLE_SIGNIN_CLIENT_SECRET_CONTENTS_BASE64=
-GOOGLE_SIGNIN_CLIENT_SECRET_FILEPATH=/signin.json
-GOOGLE_EMAIL=
-GOOGLE_PASS=
-GITHUB_TOKEN=
-REDIS_URL=redis://<username>:<password>@<hostname>:6379
-SIS_CLASS_APP_ID=
-SIS_CLASS_APP_KEY=
-SIS_COURSE_APP_ID=
-SIS_COURSE_APP_KEY=
+PORT=5001
+URL=http://localhost:5001
+BACKEND_PATH=/api
+GRAPHQL_PATH=/graphql
+NODE_ENV=development
+MONGODB_URI=mongodb://mongodb:27017/bt
+REDIS_URI=redis://redis:6379
+
+SIS_CLASS_APP_ID=_
+SIS_CLASS_APP_KEY=_
+SIS_COURSE_APP_ID=_
+SIS_COURSE_APP_KEY=_
+
+GOOGLE_CLIENT_ID=_
+GOOGLE_CLIENT_SECRET=_
+SESSION_SECRET=_

.github/workflows/cd-branch.yml

@@ -0,0 +1,35 @@
+name: 
+  Deploy to Dev
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SSH into Hozer
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: hozer-51.ocf.berkeley.edu
+          username: root
+          key: ${{ secrets.SSH_KEY }}
+          script: | 
+            cd /berkeleytime
+            git checkout ${{ github.event.pull_request.head.sha }}
+            git pull
+            docker compose up --build -d
+            docker tag berkeleytime-backend octoberkeleytime/bt-backend:${{ github.event.pull_request.head.sha }}
+            docker tag berkeleytime-frontend octoberkeleytime/bt-frontend:${{ github.event.pull_request.head.sha }}
+            docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+            docker push octoberkeleytime/bt-backend:${{ github.event.pull_request.head.sha }}
+            docker push octoberkeleytime/bt-frontend:${{ github.event.pull_request.head.sha }}
+            helm install bt-dev-app ./app --namespace=bt \
+              --set host=${{ github.event.pull_request.head.sha }}.stanfurdtime.com \
+              --set mongoUri=mongodb://bt-dev-mongo-mongodb.bt.svc.cluster.local:27017/bt \
+              --set redisUri=redis://bt-dev-redis-master.bt.svc.cluster.local:6379 \
+              --set nodeEnv=development \
+              --set frontend.image.tag=${{ github.event.pull_request.head.sha }} \
+              --set backend.image.tag=${{ github.event.pull_request.head.sha }}

.github/workflows/cd-master.yml

@@ -0,0 +1,30 @@
+name: 
+  Deploy to Staging
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SSH into Hozer
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: hozer-51.ocf.berkeley.edu
+          username: root
+          key: ${{ secrets.SSH_KEY }}
+          script: | 
+            cd /berkeleytime
+            git checkout master
+            git pull
+            docker compose up --build -d
+            docker tag berkeleytime-backend octoberkeleytime/bt-backend:latest
+            docker tag berkeleytime-frontend octoberkeleytime/bt-frontend:latest
+            docker login -u ${{ secrets.DOCKER_USERNAME }} -p ${{ secrets.DOCKER_PASSWORD }}
+            docker push octoberkeleytime/bt-backend:latest
+            docker push octoberkeleytime/bt-frontend:latest
+            kubectl rollout restart deployment bt-staging-app-backend
+            kubectl rollout restart deployment bt-staging-app-frontend

.github/workflows/gen.yaml

@@ -0,0 +1,36 @@
+name:
+  Codegen Test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  Codegen:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: install node v12
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+
+    - name: npm install
+      run: npm install
+
+    - name: gen
+      run: npm run generate
+
+    - name: test diff
+      uses: tj-actions/verify-changed-files@v14
+      id: test-diff
+      with:
+        files: |
+          **/generated-types/*.ts
+
+    - if: steps.test-diff.outputs.files_changed == 'true'
+      run: |
+        echo "Run 'npm run generate' to fix!"
+        exit 1
+

.github/workflows/lint.yaml

@@ -0,0 +1,20 @@
+name: 
+  Linting
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  Lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - name: install node v12
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12
+    - name: npm install
+      run: npm install
+    - name: lint
+      run: npm run lint

README.md

@@ -5,9 +5,21 @@
 A course discovery and planning tool which combines all of UC Berkeley's academic information in one place. We intend to make it a more accurate and powerful tool than anything students currently use.
 
 Berkeleytime was created by [Yuxin Zhu](http://yuxinzhu.com/) and [Noah Gilmore](https://noahgilmore.com) and is maintained by [the ASUC Office of the CTO](https://octo.asuc.org/).
+# Getting started
 
-## Development
+Create an `.env` file with the keys in `.env.template` populated accordingly.
 
-Much of the current development is on [the node branch](https://github.com/asuc-octo/berkeleytime/tree/node).
+Start Docker before running these in repo root
 
-It hasn't been updated recently, but this project does have [a wiki](https://github.com/asuc-octo/berkeleytime/wiki).
+```{bash}
+docker-compose up   # CTRL+C to stop
+docker-compose down # cleaner shutdown, removes containers
+```
+
+To seed the database, run these following commands while the containers are up. You will only need to do this once.
+```{bash}
+curl -O https://storage.googleapis.com/berkeleytime/public/mdb.archive
+docker run --rm --volume "${PWD}/mdb.archive":/mdb.archive --network bt mongo:5 mongorestore --drop --host mongodb --gzip --archive=mdb.archive
+```
+
+Local site becomes available at http://localhost:8080

backend/.eslintrc.json

@@ -0,0 +1,30 @@
+{
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
+    "ignorePatterns": [
+        "node_modules/",
+        "dist/",
+        "src/**/generated-types",
+        "src/generated-types"
+    ],
+    "overrides": [
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/no-explicit-any": "off"
+    }
+}

backend/.gitignore

@@ -0,0 +1,6 @@
+node_modules/
+build/
+data/
+.env
+coverage/
+.DS_Store

backend/Dockerfile

@@ -1,6 +1,8 @@
-FROM python:3.8-slim
+FROM node:16.14.2-slim AS builder
 RUN mkdir /backend
 WORKDIR /backend
+COPY package.json .
+RUN npm install --prefer-offline --no-audit
 COPY . .
-RUN apt-get update || : && apt-get install libpq-dev gcc -y && \
-    python3 -m pip install -r requirements.txt
+RUN npm run build
+ENTRYPOINT node build

backend/README.md

@@ -0,0 +1,84 @@
+# berkeleytime-gql
+
+New playground for the node/graphql rewrite
+
+## Before you start
+
+- Duplicate the `env.example` file and rename it `.env`
+- Run `npm install`
+
+## Development
+
+- Run `npm run dev`
+- Start you docker container from the berkeleytime repo node branch
+
+#### Access to the GraphQL Playground (Dev only)
+
+- `http://localhost:5001/graphql`
+
+## Typesafety
+
+The main concern for typesafety comes from the potential inconsistency between `typedefs` (GraphQL SDL) and your actual resolvers. To maintain typesafety, we use [GraphQL Code Generation](https://www.the-guild.dev/graphql/codegen/docs/getting-started) to generate types for schemas, resolvers and more.
+
+To generate types, run `npm run generate`
+
+### Typesafety with Modules
+
+Type safety is also set up within modules, see the [documentation](https://www.the-guild.dev/graphql/codegen/docs/guides/graphql-modules) for more details.
+
+## Folder structure
+
+#### Overview
+
+```
+.
+├── src                        # Where your source code lives
+│   ├── bootstrap              # Bootstrapping and loading of the API dependencies (Express, Apollo, Database, ...)
+│   ├── db                     # Mongo schemas, models and types
+│   ├── generated-types        # Generated types from codegen
+│   ├── modules                # Business logic of the app divided by domain (such as User and Catalog)
+│   ├── tests                  # Where all our testing strategy lives
+│   ├── utils                  # Collection of utils function that we use in the project
+│   ├── config.ts              # Config of the app, sourced by environment variables
+│   └── index.ts               # Entry point of the API
+│
+├── jest-mongodb-config.js     # Optional if you don't use MongoDB!
+├── jest.config.js             # Jest configuration
+├── docker-compose.yml         # Docker compose configuration (Optional !)
+├── .env.example               # Example of what your .env file should look like
+├── .gitignore                 # Standard gitignore file
+└── codegen.ts                 # Code generation configurations
+├── package.json               # Node module dependencies
+├── README.md                  # Simple readme file
+└── tsconfig.json              # TypeScript compiler options
+```
+
+#### Module example (FOR NOW)
+
+```
+.
+├── src
+│   └── modules
+│       └── user                      # Module name
+│           ├── index.ts              # Entrypoint to the module
+│           └── generated-types       # Generated types from codegen
+│               └── module-types.ts   # Relevant GraphQL typescript types
+│           └── typedefs              # Typedefs
+│               └── [schema].ts       # A typedef for a schema
+│           ├── controller.ts         # Your crud controller methods
+│           ├── fixture.ts            # Object used for testing (can ignore)
+│           ├── formatter.ts          # Formats your db models to your controller/gql models
+│           ├── resolver.ts           # Your resolver
+│           ├── schema.ts             # Your gql schemas (and potentially typscript interfaces associated to the schemas)
+│           └── service.ts            # Business logic of your app
+```
+
+#### Build and start server for production
+
+- Run `npm start`
+
+#### Technologies used
+
+- NodeJS and TypeScript
+- GraphQL with Apollo Server
+- MongoDB Database integrated with Mongoose