Merge pull request #21 from HackNCState/dev

Deploy dashboard

Author: IAmThe2ndHuman

firebase/.firebaserc .firebasercfirebase/.firebaserc renamed to .firebaserc

@@ -0,0 +1,25 @@
+name: Deploy to Firebase Hosting on dev
+on:
+  push:
+    branches:
+      - dev
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: Build with Vite
+        run: npm run build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: ${{ secrets.GITHUB_TOKEN }}
+          firebaseServiceAccount: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_HACKNCSU_TODAY }}
+          channelId: dev
+          projectId: hackncsu-today

.github/workflows/firebase-hosting-dev.yml

@@ -0,0 +1,28 @@
+# This file was auto-generated by the Firebase CLI
+# https://github.com/firebase/firebase-tools
+
+name: Deploy to Firebase Hosting on merge
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build_and_deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+      - name: Set up Node.js
+        uses: actions/setup-node@v5
+        with:
+          node-version: 'lts/*'
+          cache: 'npm'
+      - name: Install dependencies
+        run: npm ci
+      - name: Build with Vite
+        run: npm run build
+      - uses: FirebaseExtended/action-hosting-deploy@v0
+        with:
+          repoToken: ${{ secrets.GITHUB_TOKEN }}
+          firebaseServiceAccount: ${{ secrets.FIREBASE_SERVICE_ACCOUNT_HACKNCSU_TODAY }}
+          channelId: live
+          projectId: hackncsu-today

.github/workflows/firebase-hosting-merge.yml

@@ -0,0 +1,28 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+.firebase/*
+.venv
+service-account.json

.gitignore

@@ -1,3 +1,90 @@
 # hackncsu-today
 
-Comprehensive software suite to manage Hack_NCState. Currently under development.
+## Setup guide
+
+i hope this all works if not let me know
+
+### Prerequisites
+
+- `service-account.json` file with access to the Google Sheets API (let me know if you need access)
+- `CLIENT_SECRET` value for Discord OAuth2 (let me know if you need this)
+- Your Discord username in the Registration Google Sheet (so you can log in)
+
+### 1. Tooling
+
+1. Install [Firebase CLI](https://firebase.google.com/docs/cli#install_the_firebase_cli)
+2. Install Python 3.11 or higher
+3. Install Node.js
+4. Clone this repository
+
+### 2. Configuration
+
+1. Create a Python virtual environment:
+
+   ```bash
+   python -m venv functions/venv
+   ```
+
+2. Activate the virtual environment:
+   - On Windows:
+
+     ```powershell
+     functions\venv\Scripts\activate
+      ```
+
+   - On macOS/Linux:
+
+      ```bash
+      source functions/venv/bin/activate
+      ```
+
+3. Install the required Python packages:
+
+   ```bash
+    pip install -r functions/requirements.txt
+    ```
+
+4. Install the required Node.js packages:
+
+   ```bash
+   npm install
+   ```
+
+5. This isn't best practice but we're using a service account file to allow you to access the spreadsheet data locally. Let me know and I'll share the file with you. Place it in the root of the project as `service-account.json`.
+
+6. You'll also need a file `functions/.env.local` with the following content:
+
+   ```env
+   CLIENT_SECRET=<???>
+   ```
+
+   Let me know and I'll share the client secret with you.
+
+### 3. Running Locally
+
+1. Run the backend emulator suite:
+
+   - On Windows:
+
+       ```powershell
+       $env:GOOGLE_APPLICATION_CREDENTIALS="$PWD\service-account.json"
+       firebase emulators:start --project=hackncsu-today
+       ```
+
+   - On macOS/Linux:
+
+       ```bash
+       export GOOGLE_APPLICATION_CREDENTIALS="$PWD/service-account.json"
+       firebase emulators:start --project=hackncsu-today
+       ```
+
+   The emulator will ask you to configure some parameters. I set defaults for these
+   so you can just hit enter to accept them.
+
+2. Run the frontend:
+
+   ```bash
+   npm run dev
+   ```
+
+3. Open your browser and navigate to `http://localhost:8080` to see the application running locally.

README.md

@@ -0,0 +1,34 @@
+{
+	"$schema": "https://biomejs.dev/schemas/2.2.6/schema.json",
+	"vcs": {
+		"enabled": false,
+		"clientKind": "git",
+		"useIgnoreFile": false
+	},
+	"files": {
+		"ignoreUnknown": false
+	},
+	"formatter": {
+		"enabled": true,
+		"indentStyle": "tab"
+	},
+	"linter": {
+		"enabled": true,
+		"rules": {
+			"recommended": true
+		}
+	},
+	"javascript": {
+		"formatter": {
+			"quoteStyle": "double"
+		}
+	},
+	"assist": {
+		"enabled": true,
+		"actions": {
+			"source": {
+				"organizeImports": "on"
+			}
+		}
+	}
+}

biome.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "",
+    "css": "src/index.css",
+    "baseColor": "neutral",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "iconLibrary": "lucide",
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils",
+    "ui": "@/components/ui",
+    "lib": "@/lib",
+    "hooks": "@/hooks"
+  },
+  "registries": {}
+}

components.json

@@ -26,12 +26,35 @@
     "ui": {
       "enabled": true
     },
-    "singleProjectMode": true
+    "singleProjectMode": true,
+    "hosting": {
+      "port": 5000
+    },
+    "storage": {
+      "port": 9199
+    }
   },
   "firestore": {
     "database": "(default)",
     "location": "nam5",
     "rules": "firestore.rules",
     "indexes": "firestore.indexes.json"
+  },
+  "hosting": {
+    "public": "dist",
+    "ignore": [
+      "firebase.json",
+      "**/.*",
+      "**/node_modules/**"
+    ],
+    "rewrites": [
+      {
+        "source": "**",
+        "destination": "/index.html"
+      }
+    ]
+  },
+  "storage": {
+    "rules": "storage.rules"
   }
 }