feat: Add Employee Directory Demo Plugin (2M Records Performance Showcase)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 18/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- react, sqlite, tailwindcss, typescript, vite
- Domain
- api, backend, data, frontend, performance
Research direction
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.
Written by the indexing model from the issue text.
Description
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
- Dominant language
- TypeScript
- Stars
- 1.8k
- Forks
- 219
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 67
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SonicJs-Org/sonicjs
-
bug(admin/users): server error returns bare alert HTML causing black-shape visual artifactPossibly taken @lane711 claimed this today. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SonicJs-Org/sonicjs#1211 ·
Maintainers usually reply within 1 day
-
area: api bug priority: P2
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
SonicJs-Org/sonicjs#1200 ·
Maintainers usually reply within 1 day
-
ResendProvider cannot send on Workers: unbound `fetch` stored as an instance property throws "Illegal invocation"Possibly taken @lane711 claimed this 23 days ago. Openarea: email bug priority: P1
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SonicJs-Org/sonicjs#1099 ·
Maintainers usually reply within 1 day
-
Email plugin settings are never read: loadDbEmailSettings queries a v2 `plugins` table that does not exist in v3Possibly taken @lane711 claimed this 23 days ago. Openarea: email bug priority: P1
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
SonicJs-Org/sonicjs#1098 ·
Maintainers usually reply within 1 day
-
area: documentation bug documentation priority: P2
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SonicJs-Org/sonicjs#1012 ·
Maintainers usually reply within 1 day
All issues in SonicJs-Org/sonicjs
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
AloisSeckar/elrh-cosca#36 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
cursor/community-plugins#572 ·
Maintainers usually reply within 1 day
-
[Plugin] calendarOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
MUKE-coder/grit#228 ·
-
bug status:needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
dongdongbh/Mindwtr#1587 ·
Maintainers usually reply within 1 day