DashboardSupportWelcome

👤 USER DOCS

Getting Started

Daily Operations

Shift Workspace & TasksPre-Shift SetupLine-Up CardsShift ReportsForms

Staff & Locations

Staff SchedulingManaging Locations

Oversight

Manager ReportsAnalyticsPre-Shift & Compliance

Incidents & Feedback

Incident ReportingAnonymous FeedbackMessages & Announcements

AI & Settings

AI ChatgearApp Settings

Administration

Dashboard & OnboardingAdmin

⚙️ DEVELOPER DOCS

Getting Started

Getting StartedDevelopmentDeployment Guide

Architecture

Architecture OverviewData FlowArchitecture Decision Records

Core Domain

Core DomainDatabase ReferenceLocations DomainAuth & RBACScheduling DomainReports DomainIncidents DomainNotifications DomainAudit Log & OptimizationDesign Audit Findings

Frontend

Frontend ArchitectureFormsLoading SkeletonsComponentsPWA & NotificationsimageScreenshots

API Reference

API Reference

Endpoints

POS Sales APIOptimization Data APISchedule Shifts APIEmployee Export APIReports APIIncidents APIAI Chat APIPush Notifications APIWebhooks APICron API

Contributing

ContributingcodeCode Examples

Security

Security & Compliance
Danvas IconDanvas
Danvas IconDanvas

Contributing

Guidelines for contributing to the Danvas platform

Overview

We welcome contributions! This guide explains our coding standards, testing patterns, and the process for submitting changes.

Engineering Standards

  • Consistency: Adhere to existing naming conventions and architectural patterns.
  • Type Safety: No any. Use strict TypeScript and Drizzle-generated types.
  • Surgical Changes: Keep pull requests focused on a single task. Avoid unrelated refactoring.
  • Self-Documentation: Write clear, descriptive code. Use inline comments for complex business logic only.

Coding Style

We use Biome for linting and formatting.

# Lint and fix
bun run lint

# Format
bun run format

Refer to the Code Style guide for detailed conventions.

Testing

Every change MUST include tests.

  • Unit Tests: Use Vitest for package-level logic.
  • E2E Tests: Use Playwright for critical app flows (sign-in, filing reports).

Run tests from the repository root:

Cron API

Internal endpoints for scheduled operational tasks

Code Examples

Code patterns used in Danvas development

On this page

OverviewEngineering StandardsCoding StyleTestingSubmission ProcessRelated
bun run test          # Run all test suites
bun run test:unit     # Unit tests only
bun run test:e2e      # E2E tests only

Submission Process

  1. Create a Branch: git checkout -b feature/your-feature-name.
  2. Commit Changes: Use descriptive, atomic commits.
  3. Open a PR: Target the main branch. Complete the PR template.
  4. Code Review: Address all feedback from the engineering team.
  5. Merge: Once approved and passing CI, your changes will be merged.

Related

Code Style

Architecture Overview

Database Schema