@dreamwalk-os/expo-dreamwalk-template v1.4.1

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
  • Environment Variables
  • Running the Project
  • Available Scripts

Installation

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

git clone https://github.com/your-username/expo-dreamwalk-template.git
cd expo-dreamwalk-template

2. Install the dependencies:

npx expo install

3. Add packages

npx expo install <package-name>

For dev dependencies, add -- --dev at the end

Environment Variables

Create a .env file in the root directory of the project and add the following environment variables:

API_URL=https://api.example.com
ANOTHER_VARIABLE=your_value

Running the Project

To start the development server, run:

yarn start

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.