Expo React Native Template

A Expo React Native Project to kick start your journey.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Testing
5. Documentation
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

Built With

(back to top)

Getting Started

This project is a starter template for a React Native application using Expo. Follow the instructions below to set up the environment and run the app on your local machine.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (LTS version)
• npm (comes with Node.js) or Yarn
• Git (optional, for cloning the repository)

Installation

1. Install Expo CLI

Expo CLI is the command line utility for developing and building Expo apps. To install Expo CLI, run the following command:

npm install -g expo-cli

Or if you prefer using Yarn:

yarn global add expo-cli

2. Clone the repository (Optional)

Clone the repo

git clone https://github.com/sampoate/expo-react-native-template.git

3. Navigate to your project directory

If you've just created a new project:

cd my-project

4. Install dependencies

To install the project dependencies, run:

npm install

Or if you prefer using Yarn:

yarn install

(back to top)

Usage

Once the installation is complete, you can run the app using the following command:

expo start

Viewing the App on Your Device

To view the app on your mobile device, download the Expo Go app from the App Store (iOS) or Google Play Store (Android). Scan the QR code provided by the Expo developer tools using the Expo Go app.

Alternatively, you can run the app on an iOS or Android emulator.

Building the App

When you're ready to build the app for production, you can use the following commands:

For iOS:

expo build:ios

For Android:

expo build:android

Follow the instructions on the screen to complete the build process.

(back to top)

Testing

Testing is an important part of the development process and often the neglected one. This starter code comes up with Jest and React Testing Library for unit testing and Detox for E2E testing.

Unit Testing

To run the unit tests, run the following command:

yarn run test

E2E Testing

To setup Detox, follow the instructions at Expo Detox Documentation.

Documentation

Here are some helpful links to get you started:

• Expo
• Expo CLI
• React Native
• Tailwind CSS

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Sam Poate - @sampoatedev

Project Link: https://github.com/sampoate/expo-react-native-template

(back to top)

Acknowledgments

• React Native Boilerplate

(back to top)