Analytics & Usage Dashboard
Relevant source files
The following files were used as context for generating this wiki page:
The Analytics & Usage Dashboard provides private administrative tools for the Inkweave platform. This system allows administrators to monitor application activity and manage internal resources securely. It operates independently from the public Inkweave application to ensure administrative tasks remain isolated.
The dashboard integrates with the core platform by pinning the public repository as a submodule. This structure allows the admin tools to reference specific versions of the primary application logic while maintaining a separate deployment lifecycle.
Sources: README.md:1-4
System Architecture
The administrative system follows a decoupled architecture that separates management logic from the user-facing application. It relies on a submodule reference to access the core Inkweave codebase.
Core Components
The dashboard consists of several structural elements that facilitate administrative operations:
- Private Admin Repository: Contains the specific tools, views, and logic for internal usage monitoring.
- Upstream Submodule: References the public
Doberjohn/inkweaverepository at a specific commit. - Vercel Deployment Layer: Manages the hosting environment and handles access control through Vercel Login.
The following diagram illustrates the relationship between the admin dashboard and the core platform:
The diagram shows how the private admin repository tracks the core platform via a submodule while remaining protected by an authentication layer.
Sources: README.md:1-5
Deployment and Security
The dashboard deploys to a dedicated Vercel project. Security is enforced through mandatory authentication, ensuring only authorized personnel access usage data.
Security Implementation
Access control is managed at the platform level rather than the application level. Users must authenticate through Vercel to reach the dashboard interface. This configuration prevents public exposure of sensitive analytics and usage metrics.
| Feature | Implementation | Description |
|---|---|---|
| Hosting | Vercel | Provides the execution environment for the admin tools. |
| Access Control | Vercel Login | Restricts access to authenticated team members only. |
| Code Isolation | Private Repo | Keeps administrative logic separate from public code. |
Sources: README.md:4-5
Project Governance and Planning
The development and operation of the dashboard follow specific internal guidelines and roadmaps.
Documentation Resources
Three primary files define the behavior and future of the dashboard:
- README.md: Provides the high-level overview and deployment instructions.
- docs/PLAN.md: Outlines the design, detailed plans, and current phase status of the admin tools.
- CLAUDE.md: Establishes the working rules and coding standards for the project.
Sources: README.md:7-8
Integration Strategy
The system uses a submodule strategy to maintain synchronization with the public Inkweave application. This allows the admin dashboard to utilize data models or shared logic from the main app without duplicating code.
The sequence diagram demonstrates how the admin dashboard pulls logic from the public repository through the submodule bridge.
Sources: README.md:3-4
The Analytics & Usage Dashboard serves as the central hub for Inkweave administrative operations. By utilizing a private Vercel deployment and a git submodule architecture, it maintains high security while staying aligned with the core application's development.