feat: Add Employee Directory Demo Plugin (2M Records Performance Showcase)
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 18/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- react, sqlite, tailwindcss, typescript, vite
- Ambito
- api, backend, data, frontend, performance
Direzione di ricerca
Start with the monorepo root package.json workspaces and an existing packages/ plugin to copy its layout, then read the local edgecache-demo source the issue points to. The work touches packages/employee-directory-demo/src/schema, src/routes/employees.ts and src/seed/generator.ts, plus the frontend components and demo/wrangler.toml. Done means the package builds, /api/v1/employees returns filtered, paginated results with a source field, and the demo deploys. The scope is large and the thread has been quiet for about eight months, so confirm with maintainers before starting.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Overview
Import the Edge Cache Demo from the standalone repository into the SonicJS monorepo as a dedicated Employee Directory Demo Plugin. This demo showcases SonicJS's exceptional performance handling large datasets (2M+ records with relations) on Cloudflare's edge infrastructure.
Live Demo: https://edgecache-demo.pages.dev/
Source Repository: https://github.com/lane711/edgecache-demo (to be imported from local /Users/lane/Dev/refs/edgecache-demo)
Motivation
- Performance Showcase: Demonstrates SonicJS handling 2 million employee records with department relations at sub-50ms response times
- Edge Computing Benefits: Shows the speed advantage of edge-cached APIs vs traditional origin servers
- Plugin Architecture Example: Serves as a reference implementation for building demo plugins
- Marketing Asset: Provides tangible performance proof for the SonicJS website and documentation
Proposed Implementation
1. Create Demo Plugin Package
Add a new package at packages/employee-directory-demo/ with the following structure:
packages/employee-directory-demo/
├── package.json
├── README.md
├── src/
│ ├── index.ts # Plugin export
│ ├── schema/
│ │ └── employees.ts # Employee + Department schema definitions
│ ├── routes/
│ │ └── employees.ts # API routes for employee listing
│ ├── seed/
│ │ └── generator.ts # Seed data generator for 2M records
│ └── frontend/
│ ├── App.tsx # React demo frontend
│ ├── components/
│ │ ├── Sidebar.tsx
│ │ ├── Persons.tsx
│ │ ├── Stats.tsx
│ │ ├── Pagination.tsx
│ │ └── ...
│ └── index.css
└── demo/
├── wrangler.toml # Cloudflare Pages config
└── index.html
2. Core Features to Include
Backend (Plugin):
- Employee content type with fields: name, email, avatar, department (relation), region, gender
- Department content type
- Efficient API endpoints with filtering:
/api/v1/employees?filters[department][$eq]=Engineering - Support for pagination:
limit,offsetquery params - Performance headers:
sonicjs-source: cache|origin
Frontend (Demo App):
- Employee grid view with avatar cards
- Sidebar filters: Department, Gender, Region (multi-select)
- Real-time performance stats display (response time in ms)
- Toggle between "Edge Cache" and "Origin" modes to compare speed
- Pagination controls
- API URL display for transparency
3. Current Demo Dependencies
The existing demo uses:
- React 18.3
- Tailwind CSS 3.4
- @headlessui/react 2.1 (for filter UI)
- @heroicons/react 2.1 (for icons)
- Vite 5.4 (bundler)
4. Tasks
- Create
packages/employee-directory-demo/package structure - Define Employee and Department schemas using SonicJS content types
- Port existing React components from edgecache-demo repo
- Convert JSX to TypeScript/TSX
- Create seed data generator script for populating demo database
- Add deployment configuration for Cloudflare Pages
- Update monorepo
workspacesin rootpackage.json - Add to www site navigation/demo section
- Document plugin usage and deployment steps
5. API Design
Employee Listing Endpoint:
GET /api/v1/employees
Query params:
- limit (default: 18)
- offset (default: 0)
- filters[department][$eq]=<department_name>
- filters[gender][$eq]=<male|female>
- filters[region][$eq]=<region_name>
Response:
{
"data": [...employees],
"total": 2000000,
"source": "cache" | "origin"
}
6. Benefits of Plugin Architecture
- Isolated codebase: All demo code lives in one package
- Reusable schema: Other apps can extend or reference the employee data model
- Independent deployment: Demo can be deployed separately to showcase performance
- Test fixture: Useful for performance testing and benchmarking
Additional Considerations
- Should support both D1 (SQLite) and Turso database adapters
- Consider pre-generated sample avatars or use a deterministic avatar service
- May want to add OpenAPI documentation for the demo endpoints
References
- Current live demo: https://edgecache-demo.pages.dev/
- SonicJS Docs: https://sonicjs.com/docs
- Cloudflare Workers: https://developers.cloudflare.com/workers/
/cc @lane711
- Lingua principale
- TypeScript
- Stelle
- 1.8k
- Fork
- 219
- Merge medio
- 2g 21h
- PR unite (30g)
- 67
Preparare l'ambiente
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di SonicJs-Org/sonicjs
-
bug(admin/users): server error returns bare alert HTML causing black-shape visual artifactForse già presa @lane711 l’ha presa oggi. Apertabug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
SonicJs-Org/sonicjs#1211 ·
I maintainer di solito rispondono entro 1 giorno
-
area: api bug priority: P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
SonicJs-Org/sonicjs#1200 ·
I maintainer di solito rispondono entro 1 giorno
-
ResendProvider cannot send on Workers: unbound `fetch` stored as an instance property throws "Illegal invocation"Forse già presa @lane711 l’ha presa 23 giorni fa. Apertaarea: email bug priority: P1
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
SonicJs-Org/sonicjs#1099 ·
I maintainer di solito rispondono entro 1 giorno
-
Email plugin settings are never read: loadDbEmailSettings queries a v2 `plugins` table that does not exist in v3Forse già presa @lane711 l’ha presa 23 giorni fa. Apertaarea: email bug priority: P1
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
SonicJs-Org/sonicjs#1098 ·
I maintainer di solito rispondono entro 1 giorno
-
area: documentation bug documentation priority: P2
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
SonicJs-Org/sonicjs#1012 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di SonicJs-Org/sonicjs
Issue simili
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 78/100
lingdojo/kana-dojo#34344 · 1 commento · 5 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
documentation good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno
-
bug priority:low
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Konfirm-xyz/konfirm-frontend#369 ·
I maintainer di solito rispondono entro 1 giorno