Skip to main content

Quick Start

Skip the installation process and get started immediately with a pre-configured Ovok Mobile SDK application. This starter app includes authentication flows and a patient list with search functionality.

Note: This project is only for demonstration purposes and uses public-example tenant code. Follow this guide to use your own project​

🚀 Clone and Run​

Get up and running in minutes with our starter repository:

git clone https://github.com/Ovok-Dev/minimal-patient-list-example
cd minimal-patient-list-example
bun install

# This project needs to be run as development build. Expo go is not supported.
bun android
# Or
bun ios

📱 What's Included​

The starter app comes with everything you need to begin developing with the Ovok Mobile SDK:

✅ Pre-configured Features​

  • Authentication System

    • Login screen with email/password
    • Google Sign-In integration
    • Apple Sign-In (iOS only)

  • Patient Management

    • Patient list with search functionality
    • Patient card components

  • Complete Setup

    • All required dependencies installed
    • Platform-specific configurations
    • Theme and styling system
    • Navigation structure

🛠 Technical Stack​

  • React Native with Expo SDK 53
  • Expo Router for navigation
  • Ovok Mobile SDK with all components
  • TypeScript for type safety
  • Pre-configured authentication providers

🎯 Key Screens​

Login Screen​

  • Email/password authentication
  • Social login buttons (Google, Apple)

Home Screen​

  • Patient list display
  • Search functionality
  • Patient card interactions

🔧 Customization​

Use your own project​

Edit config.ts to use your own project. First you need to get your tenant code. Please follow this guide to get your tenant code.

export const PROJECT_CONFIG = {
  tenantCode: "public-example", // replace it with yours
};

Update Configuration​

Edit app.config.ts to customize:

export default {
  expo: {
    name: "Your App Name",
    slug: "your-app-slug",
  },
};

Modify Theme​

Update theme colors in app/_layout.tsx:

<OvokThemeProvider
  theme={{
    colors: {
      ...DEFAULT_COLORS,
      primary: "#your-primary-color",
      background: "#your-background-color",
    },
    // ... other theme options
  }}
>

Add Your Branding​

Replace logo and assets in the assets/ directory:

  • icon.png - App icon
  • splash.png - Splash screen
  • logo.png - In-app logo

📋 Next Steps​

Once you have the starter app running:

  1. Explore the Code - Familiarize yourself with the component structure
  2. Customize Authentication - Update login flows for your requirements
  3. Extend Patient Features - Add more patient management functionality
  4. Add New Screens - Build additional features using SDK components
  5. Configure APIs - Connect to your backend services

🆘 Need Help?​

If you encounter any issues or need assistance:

🔗 Repository Features​

The starter repository includes:

  • Working Examples - Real implementations of all core features
  • Best Practices - Proper SDK usage patterns
  • Type Safety - Full TypeScript definitions

Ready to dive deeper? Continue with the Installation Guide for a custom setup or explore the Component Documentation to learn about individual SDK components.