The project uses Expo Router with a pre-configured navigation structure which has updated from react-navigation. The navigation structure is based on file-based routing, making it easier to manage and navigate between screens. The project has a pre-configured navigation structure with a drawer and tab navigation. You can easily add new screens and navigations by following the existing structure:

Root (Drawer)
├── Home Tab
│   └── Stack
│       ├── Home Screen
│       └── Details Screen
└── Profile Tab
    └── Stack
        ├── Profile Screen
        └── Details Screen

State Management with Redux Toolkit

This project uses Redux Toolkit for global state management, pre-configured with Redux Hooks for immediate use.

Getting Started

1. Explore existing slices in the src/slices directory
2. See usage examples in src/app/_layout.tsx

Adding New State

1. Copy src/slices/app.slice.ts
2. Rename and modify for your needs
3. Add your slice to src/utils/store.ts

The project simplifies asset and theme management through a centralized src/theme directory that handles images, icons, fonts, and colors, with built-in asset preloading and SVG support for optimal performance, while also providing a custom useColorScheme hook (located in src/hooks/useColorScheme.ts) that automatically detects and adapts colors based on the current theme across both mobile and web platforms - making it easy to implement dynamic theming by returning the current color scheme name and flags (isDark, isLight) for conditional styling.

Environment Variables Management

The project uses dotenvx to handle environment variables across both Expo CLI and EAS CLI builds. Here's how it works:

Setup Structure

• .env.dev.example - Development environment template (ENV=dev, dev:* scripts)
• .env.stg.example - Staging environment template (ENV=stg, stg:* scripts)
• .env.prod.example - Production environment template (ENV=prod, prod:* scripts)

Each environment uses its own EAS project through EXPO_PROJECT_ID. Every dev:* script has stg:* and prod:* versions.

• Configuration in app.config.ts and src/utils/config.ts

Getting Started with Your Expo Account

1. Rename .env.dev.example to .env.dev
2. Update owner in app.json with your Expo username
3. Set your EXPO_SLUG and EXPO_PROJECT_ID in .env.dev

Adding New Environment Variables

1. Add variables to .env.dev, .env.stg, and .env.prod (and their .example files)
2. Include them in app.config.ts under the extra object
3. Define them in src/utils/config.ts

Verify Configuration

• Check variables in the app's bottom sheet OR...
• Run npm run dev:config:public to view loaded variables in console

Environment Variables & Security

The project intentionally avoids using EXPO_PUBLIC_ prefix for environment variables, instead utilizing EAS secrets for enhanced security. Here's why:

Current Approach

• Variables are uploaded to EAS servers as secrets
• Securely accessible only during EAS build and submit processes
• Use npm run dev:secret:push, stg:secret:push, or prod:secret:push to upload variables from .env.dev, .env.stg, or .env.prod to that environment's EAS project

Alternative Approach

If you prefer direct access via process.env:

• Use EXPO_PUBLIC_ prefix for non-sensitive data
• Warning: Never store sensitive information with EXPO_PUBLIC_ prefix as it exposes data to clients
• For sensitive data handling, follow React Native's security guidelines for storing sensitive information

The project streamlines deployment with simple commands - use npm run dev:build:mobile to generate iOS (IPA) and Android (APK) distributions, and npm run dev:deploy:web to deploy the web version to EAS Hosting.

Development:

• npm run dev - Run on all platforms
• npm run dev:ios - Run iOS only
• npm run dev:android - Run Android only
• npm run dev:web - Run web only

Building:

• npm run dev:build:mobile - Build mobile apps
• npm run dev:build:web - Build web app
• npm run dev:deploy:web - Deploy web app to EAS Hosting

Testing:

• npm run check-types - Check types
• npm run lint - Run ESLint
• npm run format - Run Prettier
• npm run test - Run Jest tests
• npm run e2e - Run Maestro E2E flows

Maestro flows live in .maestro. They cover the welcome sheet, the Home and Profile tabs, the Details screen, and the drawer. Each flow starts from subflows/launch.yaml, which launches the app with a clean state and closes the welcome sheet.

1. Install the Maestro CLI
2. Build and install the app on a simulator with npm run dev:run:ios (or npm run dev:run:android). Keep the Metro server it starts running
3. Run the flows with npm run e2e (or npm run e2e:android)

The scripts read the app ID from EXPO_IOS_BUNDLE_IDENTIFIER or EXPO_ANDROID_PACKAGE in .env.dev. Target elements by testID when you add flows.

dev:run:ios and dev:run:android reuse existing ios/ and android/ folders. Delete them after changing .env.dev or app.config.ts, or the app keeps the old bundle ID and the flows cannot find it.

The project maintains code quality through integrated Eslint, Prettier, and Jest configurations - code is automatically scanned and formatted during development (especially with 'Format on Save' enabled), while pre-commit hooks verify, format, and test your code to ensure all commits meet quality standards.

• Branches: work branches merge into dev. Promote dev → stg for staging tests, then stg → main for production. Releases are tagged on main.
• When you've completed your work and need to share a preview with the QA team, our boilerplate automates the distribution process for you. Here's how it works:

1. Whenever you create a pull request (PR) or merge, it automatically generates a preview channel in your Expo account.
2. You don't need to run 'eas' commands every time you create a PR; the process is streamlined for you.
3. The continuous delivery (CD) process is managed through the preview.yml configuration file, which utilizes expo-github-action.

To set up the CD workflow, follow these steps:

1. Create an EXPO_TOKEN in your Expo account. You can do this by visiting this link.
2. In your GitHub repository, go to Settings, then navigate to Secrets and variables -> Actions -> Add new repository secret. Make sure to name the secret as EXPO_TOKEN.
3. Update name, slug, owner, projectId and url in app.json:
4. Update in name, slug, projectId, ios, android in app.config.ts
5. After you push changes to dev, stg, or main, a new update is published to the EAS branch with the same name.

• npm run dev - Start Expo development server for all platforms with cache cleared
• npm run dev:ios - Start development server for iOS simulator only
• npm run dev:android - Start development server for Android emulator only
• npm run dev:web - Start development server for web browser only
• npm run dev:doctor - Run Expo diagnostics to check project health
• npm run dev:run:ios - Build and run the native iOS app locally
• npm run dev:run:android - Build and run the native Android app locally

Replace dev with stg or prod to use .env.stg or .env.prod.

• npm run dev:build:mobile - Build iOS (IPA) and Android (APK) using EAS Build for development
• npm run dev:build:web - Export static web application to dist/ directory
• npm run dev:serve:web - Serve the built web app locally (run after dev:build:web)
• npm run dev:deploy:web - Build and deploy web app to EAS Hosting

• npm run dev:secret:push - Upload environment variables from .env.dev to EAS secrets
• npm run dev:secret:list - List all environment variables stored in EAS
• npm run dev:config:public - Display current Expo configuration for debugging

• npm run check-types - Check types with TypeScript
• npm run lint - Run ESLint to check code quality and style
• npm run lint:staged - Run linting only on staged Git files (used in pre-commit)
• npm run format - Format code using Prettier
• npm run test - Run Jest unit tests
• npm run test:watch - Run Jest tests in watch mode for development
• npm run e2e - Run Maestro E2E flows on the iOS simulator
• npm run e2e:android - Run Maestro E2E flows on the Android emulator
• npm run prepare - Set up Husky Git hooks for pre-commit quality checks

Start development:

npm run dev                    # All platforms
npm run dev:web               # Web only

Build and deploy web:

npm run dev:build:web         # Build static files
npm run dev:serve:web         # Test locally
npm run dev:deploy:web        # Deploy to EAS Hosting

Code quality:

npm run lint                  # Check code
npm run format               # Format code
npm run test                 # Run tests
npm run e2e                  # Run E2E flows