CLUCK Version 2

.github/workflows/ci.yaml

@@ -0,0 +1,47 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+    lint:
+        name: 'Lint'
+        runs-on: ubuntu-latest
+        permissions:
+            checks: write
+        steps:
+            - uses: actions/checkout@v4
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 21
+                  cache: 'npm'
+            - name: Install Node Dependencies
+              run: npm ci
+
+            # Linting
+            - name: Create ESLint Report
+              run: node_modules/.bin/eslint --output-file eslint_report.json --format json .
+              continue-on-error: true
+            - name: Annotate Code Linting Results
+              uses: ataylorme/eslint-annotate-action@v3
+              continue-on-error: true
+              with:
+                  report-json: 'eslint_report.json'
+            - name: Run ESLint
+              run: node_modules/.bin/eslint .
+
+    build:
+        name: 'Build'
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - name: Setup Node
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 21
+                  cache: 'npm'
+            - name: Install Node Dependencies
+              run: npm ci
+            # Build
+            - name: Build
+              run: npm run build

.gitignore

@@ -1,10 +1,40 @@
-/node_modules/
-/secrets/*
-!/secrets/*.example.*
-/coverage/
-/dist/
-/data/
+# dev
+.yarn/
+!.yarn/releases
+.vscode/*
+!.vscode/launch.json
+!.vscode/*.code-snippets
+.idea/workspace.xml
+.idea/usage.statistics.xml
+.idea/shelf
 
-**/.DS_Store
-npm-debug.log
+# deps
+node_modules/
 
+# env
+.env
+.env.production
+
+# logs
+logs/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+# misc
+.DS_Store
+
+
+/config/*.*
+!/config/custom-environment-variables.json
+!/config/example.json
+/static/app.css
+_*.ts
+/.idea
+/public/
+
+/dev/*.manifest.json
+/build/

.prettierrc

@@ -0,0 +1,17 @@
+{
+    "trailingComma": "none",
+    "bracketSpacing": true,
+    "quoteProps": "consistent",
+    "tabWidth": 4,
+    "semi": false,
+    "singleQuote": true,
+    "printWidth": 1000,
+    "overrides": [
+        {
+            "files": ["**/*.ts"],
+            "options": {
+                "printWidth": 180
+            }
+        }
+    ]
+}

MAINTAINING.md

@@ -0,0 +1,65 @@
+# Maintaining
+
+## Adding Members
+
+Visit `/admin/members/` and enter data in the bottom row. Slack IDs will automatically populate by the email
+Alternatively use the onboarding button on the app home
+
+## Creating Accounts
+
+To create an account,
+Role should be "read" "write" or "admin"
+
+```
+npm run createaccount youruser yourpassword role
+```
+
+## Adjusting Seasons
+
+Set the `start_date` field to the date you want to start tracking current hour information from, typically around kickoff or the end of summer. Any hour submissions after this point will be counted towards totals. It can be in any format accepted by the [Javascript Date constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)
+
+## Refreshing Veracross photos
+
+Open [the student directory](https://portals.veracross.com/catlin/student/directory/1) and paste the following into the browser console. You may need to disable CSP to run this script.
+
+```js
+function loadNext() {
+    console.log('loading more pages...')
+    const elem = document.querySelector('.DirectoryEntries_LoadMoreEntriesButton')
+    if (elem) {
+        elem.click()
+        setTimeout(loadNext, 1000)
+    } else {
+        const people = document.querySelectorAll('.directory-Entry_Header')
+        const data = {}
+        people.forEach((person) => {
+            const email = person.querySelector('a')?.innerHTML?.trim()
+            const photo = person.querySelector('.directory-Entry_PersonPhoto--full')?.src
+            if (email && photo) {
+                data[email] = photo.replace('c_limit', 'c_fill,g_north')
+            } else {
+                console.log('missing data for', person)
+            }
+        })
+        fetch('https://cluck.team1540.org/api/members/fallback_photos', {
+            method: 'POST',
+            headers: { 'X-Api-Key': 'YOUR-API-KEY' },
+            body: JSON.stringify(data)
+        })
+            .then((resp) => resp.text())
+            .then(console.log)
+    }
+}
+
+loadNext()
+```
+
+## Adding Member Fields
+
+Additional fields not used by CLUCK can be added to the spreadsheet directly. See the [registered column](https://docs.google.com/spreadsheets/d/1p18eJW29CzLn-zZKBKm-OOM6BtR-oLlrZVfNJtNPl9A/edit?gid=568325748#gid=568325748&range=B2:B46) and ['extra' sheet](https://docs.google.com/spreadsheets/d/1p18eJW29CzLn-zZKBKm-OOM6BtR-oLlrZVfNJtNPl9A/edit?gid=2140052736#gid=2140052736) in the template spreadsheet for an example
+
+-   Hours & Certs row 3 represents the table that the column is found in
+-   Hours & Certs row 4 is the column name
+-   Hours & Certs row 5 is automatically calculated to be the column index
+
+Make sure to update [the db model](prisma/schema.prisma), [the spreadsheet mapping](src/spreadsheet/index.ts), and the [member dashboard](src/views/admin_members) if adding new fields to CLUCK.

README.md

@@ -1,19 +1,17 @@
-[![CI](https://github.com/flamingchickens1540/CLUCK/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/flamingchickens1540/CLUCK/actions/workflows/ci.yml)
+# CLUCK
 
-1. Install all node dependencies
-2. Change port/public ip in src/consts.ts if needed
-3. Run `npm run build` and `npm run serve`!
+CLUCK is a team management tool designed by and for FRC Team 1540. It manages hour tracking and certifications, integrating with Slack and Google Sheets.
 
-Pages:
-- `/grid/`
-- `/dash/`
+## Installation
 
-API:
-- `POST /api/clock`
-- `POST /api/log`
-- `POST /api/void`
-- `GET /api/loggedin`
-- `GET /api/ping`
-- `GET /api/members`
-- `GET /api/members/refresh`
+See [SETUP.md](SETUP.md) for installation instructions.
 
+## Feature Showcase
+
+| Label                    | Image                                                                                                                                                                                                                   |
+| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Spreadsheet              | [![Spreadsheet](https://github.com/user-attachments/assets/1cbaee67-7ab1-4e45-9774-339cd8300b24)](https://docs.google.com/spreadsheets/d/1p18eJW29CzLn-zZKBKm-OOM6BtR-oLlrZVfNJtNPl9A/edit?gid=568325748#gid=568325748) |
+| Slack Time Logging       | ![Slack](https://github.com/user-attachments/assets/80a61a51-43b1-4673-a483-513a408e6726)                                                                                                                               |
+| Slack User Info          | ![Slack](https://github.com/user-attachments/assets/df06e2c2-933e-4472-a1c3-cf830798bffa)                                                                                                                               |
+| Member Dashboard         | ![Dashboard](https://github.com/user-attachments/assets/3e1229ec-ecdf-44c8-9ab9-4ed958d4e78b)                                                                                                                           |
+| Certifications Dashboard | ![Certifications](https://github.com/user-attachments/assets/cdd3dbf4-bbce-4a3b-9463-8fe612d294e5)                                                                                                                      |