How ryukokudx/steam_tracker works
Project type and purpose
• Type: Full-stack automation/management system built on Google Workspace technologies.
• Purpose: Track “abandoned” items in a makerspace (“Steam Commons”), enable QR-code registration, send reminders before removal date, and allow admin actions via LINE Bot and AppSheet dashboard.
File structure
• Top-level:
• GAS/ (Google Apps Script source, code.gs)
• docs/ (design/operation guides, requirements, specifications)
• .claspignore, .gitignore (deployment and SCM filters)
• README.md, LICENSE
• No separate “frontend” folder—user registration UI is Google Forms (managed outside this codebase).
• Backend logic & automation lives entirely in GAS/code.gs.
• Configuration (env variables) drives external integrations (Sheets, LINE, Gmail).
README for additional insights
• Architecture section lists:
• Backend/Automation: GAS
• Data store: Google Sheets
• User UI: Google Forms
• Admin UI: LINE Messaging API, AppSheet
• Dev tool: clasp, GitHub, CI workflows
• Features outline how components interact (e.g., Forms → GAS → Sheets → reminder emails/LINE messages).
Components & interactions
a. Main components
• Users’ devices (mobile/desktop)
• Google Forms (item registration)
• Google Apps Script (code.gs)
• Google Sheets (data store)
• Gmail API (reminder emails)
• LINE Messaging API (admin notifications & controls)
• AppSheet dashboard
• CI/CD (GitHub Actions + clasp)
b. Relationships & data flow
1. User scans QR code → opens Google Form → submits item data.
2. Form submission triggers GAS function → writes row to Google Sheet.
3. Scheduled GAS trigger (time-based) queries Sheet for items nearing removal →
• Sends email via Gmail API
• Posts push notification to admin LINE group via LINE API
4. Admin clicks LINE Bot buttons → GAS callback archives item (updates Sheet).
5. AppSheet reads from same Google Sheet → shows dashboard for search/listing.
6. Developers push/pull code with clasp + GitHub Actions for CI.
c. Architectural patterns and design principles
• Event-driven automation (Form triggers & cron triggers)
• Single codebase (monolith) in GAS, external UIs for light frontend
• Declarative data storage (Sheets as “No-code DB”)
• Separation of concerns:
• Data capture (Forms)
• Business logic (GAS)
• Data storage (Sheets)
• Notifications (Gmail + LINE)
• Dashboard (AppSheet)
d. Key technologies & frameworks
• Google Apps Script (ES6-style JavaScript)
• clasp CLI for local development & deployment
• Google Sheets API
• Gmail (Apps Script MailApp or Gmail API)
• LINE Messaging API (webhook integration in GAS)
• AppSheet no-code platform
• GitHub Actions (CI for push/pull, tests, notifications)