How dpgalliance/publicgoods-validate works
Project type and purpose
• From the README and file tree, this is a single‐page “webapp” crowdsourcing form for validating open‐source projects against the Digital Public Goods Standard.
• The root repo simply holds a Git submodule called “webapp,” so all application code lives there. There is no separate “backend” in this repo—this is essentially a front‐end‐first project, likely calling out to external services or serverless endpoints for storage and business logic.
File structure
• Top level:
– .gitmodules → declares “webapp” as a Git submodule
– README.md, LICENSE, CODE_OF_CONDUCT.md → project metadata
– webapp/ → entire application code
• Look for any Netlify/Vercel, GitHub Actions, or Docker config to understand how it’s built and deployed.
README for additional insights
• Live app URL (https://validate.digitalpublicgoods.net) hints at a static‐hosting or serverless deployment (Netlify, Vercel, Cloudflare Pages).
• No explicit “backend” instructions here—means the front end likely calls third‐party or remotely hosted endpoints.
a. Main components
1. Developer environment & code repo (Git + webapp submodule)
2. CI/CD pipeline (GitHub Actions, Netlify/Vercel build step)
3. Static hosting / CDN (serving the SPA)
4. Browser (SPA running React/Vue/Angular)
5. External APIs / serverless functions (receiving form submissions, validating against Digital Public Goods Standard API, storing results)
6. Data store (e.g., managed database or GitHub Issues / Airtable / Firestore)
7. Third‐party integrations (e.g., authentication via GitHub OAuth, email/webhooks)
b. Relationships & interactions
– Developer pushes to GitHub → CI/CD builds webapp → deploys to CDN
– End user opens URL → CDN serves SPA → user fills form → SPA calls API endpoint (serverless or external)
– API endpoint fetches Standard definitions, applies business rules, writes review data to store → optionally triggers notifications
– Admin / dashboard client can query the data store or GitHub repo for results
c. Architectural patterns & principles
– SPA + serverless “microservices” for business logic
– Git submodule to isolate “webapp” code in its own repo
– Static hosting + CDN for global performance
– External managed services to reduce operational overhead
d. Key technologies & frameworks (tailor after you inspect webapp/)
– Frontend: React (create-react-app) or Vue CLI
– Deployment: Netlify/Vercel or GitHub Pages
– CI: GitHub Actions (build, test, deploy)
– Serverless: Netlify Functions / AWS Lambda / Vercel Serverless Functions
– Data: Firebase/Firestore, Airtable, or a SQL/NoSQL database
– Auth & integrations: GitHub OAuth APIs, email service, webhooks