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

Getting Started

Set up Danvas for local development in minutes

Overview

Welcome to Danvas! This guide will walk you through setting up the monorepo on your local machine, configuring your environment variables, and running the application suite.

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js v22 or higher.
  • Bun (highly recommended for performance).
  • Git.

Quickstart

  1. Clone the repository:

    git clone https://github.com/canvas-forge/monorepo.git
cd canvas-forge

  2. Install dependencies:

    bun install

  3. Configure Environment Variables: Copy the example environment files and fill in your secrets (Clerk, Neon, Upstash).

Admin

User management, roles, and access control

Development

Local development guide for Danvas

On this page

OverviewPrerequisitesQuickstartNext StepsRelated
cp apps/app/.env.example apps/app/.env.local
cp apps/api/.env.example apps/api/.env.local

  • Initialize the Database:

    bun db:push
bun db:seed

  • Start Development Servers:

    bun dev

    • The applications will be available at:

    • Main App: http://localhost:4000
    • Marketing Site: http://localhost:4001
    • API Backend: http://localhost:4002
    • Docs: http://localhost:4003

    Next Steps

    • Architecture: Deep dive into the monorepo architecture.
    • Development Workflow: Learn about our local development patterns.
    • Deployment: See how to deploy to Vercel.

    Related

    Architecture Overview

    Database Schema

    Contributing Guide