Expo DreamWalk Template

This project serves as a template for future projects. Follow the instructions below to set up and run the project.

Table of Contents

• Expo DreamWalk Template
  • Table of Contents
  • Installation
  • Running the Project
  • Environment Variables
  • Available Scripts

Installation

1. Initialise your new project using this as a template:

yarn create expo-app --template @dreamwalk-os/expo-dreamwalk-template --no-install

2. Install the dependencies:

cd <your_app_name>
touch yarn.lock
yarn install
npx expo prebuild

Running the Project

Once modules are installed the project can be built and run via:

yarn ios | yarn android

This will run a development environment build

Environment Variables

The template is configured for 3 environments, development, uat, and production.

A .env file exists for each of these: .env.development, .env.uat, .env.production.

When adding additional values:

• Add new key and value to each env file, prefixed with EXPO_PUBLIC_

  EXPO_PUBLIC_ANOTHER_VARIABLE=your_value

• Update config.ts

  {
    ...
    anotherVariable: process.env.EXPO_PUBLIC_ANOTHER_VARIABLE || 'YOUR_EXPO_PUBLIC_ANOTHER_VARIABLE',
  }

• Update the env property of eas.json for each environment with the key and value from the .env.development|uat|production file

  "env": {
    ...
    "EXPO_PUBLIC_ANOTHER_VARIABLE": "YOUR_EXPO_PUBLIC_ANOTHER_VARIABLE"
  },

This will start the Expo development server and you can open the project using the Expo Go app on your mobile device.

Available Scripts

• yarn start: Starts the development server.
• yarn run android: Runs the project on an Android emulator or device.
• yarn run ios: Runs the project on an iOS simulator or device.
• yarn run web: Runs the project in a web browser.
• yarn test: Runs the test suite.

For more information on how to use Expo, refer to the Expo documentation.