Merge pull request #65 from UTDNebula/develop

Update prod with redesign

.github/workflows/submit.yml

@@ -1,32 +1,37 @@
 name: 'Submit to Web Store'
+
+#Documentation for secrets: https://github.com/PlasmoHQ/bms/blob/main/tokens.md
+#There is already an existing google cloud console project that the chrome keys were generated from
+#The secrets are linked to my [email protected] email since it is a developer account and has access on both chrome and firefox
+
 on:
   workflow_dispatch:
+#This could run on each push to main but it would only work like once a day for chrome
+#Chrome won't allow submitting another package when one is in review
 
 jobs:
-  build:
+  main:
+    name: Build and publish
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v3
-      - name: Cache pnpm modules
-        uses: actions/cache@v3
-        with:
-          path: ~/.pnpm-store
-          key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            ${{ runner.os }}-
-      - uses: pnpm/[email protected]
-        with:
-          version: latest
-          run_install: true
-      - name: Use Node.js 16.x
-        uses: actions/[email protected]
+      - name: Check out Git repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
         with:
-          node-version: 16.x
-          cache: 'pnpm'
-      - name: Build and zip extension artifact
-        run: pnpm package
-      - name: Browser Platform Publish
+          node-version: 18
+
+      - name: Install packages
+        run: npm ci
+
+      - name: Build and package extension
+        run: npm run build:chrome && npm run build:firefox
+
+      - name: Publish extension
         uses: PlasmoHQ/bpp@v3
         with:
           keys: ${{ secrets.SUBMIT_KEYS }}
-          artifact: build/chrome-mv3-prod.zip
+          chrome-file: build/chrome-mv3-prod.zip
+          firefox-file: build/firefox-mv3-prod.zip

.github/workflows/type-check.yml

@@ -0,0 +1,23 @@
+name: Type Check
+
+on: push
+
+jobs:
+  main:
+    name: Run Typescript check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out Git repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+
+      - name: Install packages
+        run: npm install
+
+      - name: Run type check
+        run: npm run type-check

.gitignore

@@ -39,7 +39,7 @@ dist/
 keys.json
 
 # typescript
-.tsbuildinfo
+*.tsbuildinfo
 
 # lint cache
 .eslintcache

README.md

@@ -1,33 +1,51 @@
-This is a [Plasmo extension](https://docs.plasmo.com/) project bootstrapped with [`plasmo init`](https://www.npmjs.com/package/plasmo).
+# Skedge
 
-## Getting Started
+_Get all of your Rate My Professors and grade distribution data without ever leaving schedule planner!_
 
-First, run the development server:
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
 
-```bash
-pnpm dev
-# or
-npm run dev
-```
+## About
+
+### Features
+
+- Multiple Sources
+  - Find grade distributions and Rate My Professors scores for any given class.
+- Aggregate
+  - Powerful query abilities that aggregate grade and Rate My Professors data across several years to give you a more wholistic view.
+- Schedule Planner Integration
+  - Direct integration means getting the exact information you need, right when you need it.
 
-Open your browser and load the appropriate development build. For example, if you are developing for the chrome browser, using manifest v3, use: `build/chrome-mv3-dev`.
+## Contributing
 
-You can start editing the popup by modifying `popup.tsx`. It should auto-update as you make changes. To add an options page, simply add a `options.tsx` file to the root of the project, with a react component default exported. Likewise to add a content page, add a `content.ts` file to the root of the project, importing some module and do some logic, then reload the extension on your browser.
+Contributions are welcome!
 
-For further guidance, [visit our Documentation](https://docs.plasmo.com/)
+This project uses the MIT License.
 
-## Making production build
+### Process
 
-Run the following:
+Once you're ready to make some changes, see the
+[issues](https://github.com/UTDNebula/skedge/issues) for the repository.
+
+If you want to brainstorm, share ideas or ask questions, start a discussion in
+our [Discord](https://discord.utdnebula.com/).
+
+### Set-up
+
+This project requires a working [Node.js](https://nodejs.org/en/) and NPM
+installation. To start, clone the repository, and then run `npm run dev:chrome` or `npm run dev:firefox` to launch
+a local development server.
 
 ```bash
-pnpm build
-# or
-npm run build
+git clone https://github.com/UTDNebula/skedge.git
+cd skedge
+npm install
 ```
 
-This should create a production bundle for your extension, ready to be zipped and published to the stores.
+If you are developing for the Chrome browser run `npm run dev:chrome` and load `build/chrome-mv3-dev` on `chrome://extensions/`
+
+If you are developing for the Firefox browser run `npm run dev:firefox` and load `build/firefox-mv3-dev` on `about:debugging`
 
-## Submit to the webstores
+### Contact
 
-The easiest way to deploy your Plasmo extension is to use the built-in [bpp](https://bpp.browser.market) GitHub action. Prior to using this action however, make sure to build your extension and upload the first version to the store to establish the basic credentials. Then, simply follow [this setup instruction](https://docs.plasmo.com/framework/workflows/submit) and you should be on your way for automated submission!
+This project is maintained by Nebula Labs. If you have
+any questions about this project or Nebula Labs, see the [discord server](https://discord.utdnebula.com/)