Skip to main content

Prerequisites

Before getting started, ensure you have the following installed:
  • Node.js (>=18)
  • npm or yarn
  • Git

Installation

Clone the repository and install dependencies:
Use --legacy-peer-deps flag to resolve any peer dependency conflicts in the monorepo

Running Applications

You have two main options for running the applications during development: Turbo provides orchestrated development across the entire monorepo. Run all applications:
Run specific applications:

Option 2: Running Apps Separately

If you prefer to run applications individually or encounter issues with Turbo:

Clinical Dashboard

The clinical dashboard will be available at http://localhost:5173 Alternative start command:

Mobile Application

Alternative start command:
Platform-specific development:

Application URLs

When running successfully, applications will be available at:
  • Clinical Dashboard: http://localhost:5173
  • Mobile App (Web): http://localhost:8081 (via Expo)
  • Documentation: http://localhost:3000 (when running documentation app)

Troubleshooting

Common Issues

Peer dependency conflicts:
Turbo cache issues:
Mobile app not starting:

Environment Variables

Make sure you have the required environment variables set up:
  • Create .env files in each app directory as needed
  • Check with your team for the required environment variables

Development Tools

Recommended VS Code extensions:
  • TypeScript and JavaScript Language Features
  • Expo Tools
  • Prettier - Code formatter
  • ESLint

Next Steps

Once your development environment is running:
  1. Clinical Dashboard: Visit the Clinical User Guides to understand the application flow
  2. Mobile App: Check the Mobile Architecture documentation
  3. Backend: Review the Edge Functions Architecture for API development

Clinical User Guides

Learn how to use the clinical dashboard

Technical Architecture

Understand the system architecture

Mobile Development

Mobile app development guide

Database Schema

Backend database structure