Quick Start

Getting started with Expo Starter Kit

Introduction

Hello and congratulations on taking the first step towards elevating your mobile app deployment skills!

This *universal starter kit is designed to help you build and deploy mobile apps faster and more efficiently, learn more about Expo Starter

Run your app in 5 steps

Prerequisites

System requirements:

  • Node.js.
  • macOS, Windows (Powershell and WSL 2), and Linux are supported.

Make sure your development environment is set up correctly.

Prepare repository

In your terminal, clone the repository

terminal
git clone git@github.com:expo-starter/expo-starter-kit.git your-app-name

Set new origin for you github repository

terminal
git remote remove origin
git remote set-url origin {your-git-origin}

Copy .env.sample to .env and configure your environment variables, see environment file section for more information.

terminal
cp .env.sample .env

Please refer to the Env file section for additional details.

Install dependencies

terminal
cd your-app-name
pnpm install

Start a dev server

terminal
pnpm dev

Run dev server

Open http://localhost:8081 to see the web app version.

Run on simulator

The Expo Starter won't run on Expo Go because it includes native code that requires building the app first.

Project Structure

The project has simple structure. It’s easy to navigate and understand. Here’s the main folders:

config.ts ← It is where you configure your app
app.config.ts
.env ← Environment file
package.json

Env File

Environment file contains only secret keys and configuration variables used in server API. It is not committed to the repository.

.env
POSTGRES_URL=postgres://postgres:root@localhost:5432/mobile

The Expo Starter includes a docker-compose.yml file to simplify running PostgreSQL. Before using it, ensure you have Docker installed.

docker-compose up -d

Configuration Files

config.ts file

It is where you configure your app. Every key is meticulously documented and will be explains in later. It's essential to review this carefully.

app.config.ts file

This is essential Expo App config, this file will be detailed later for more information.

Next

Prerequisites

On this page