Skip to main content
Get started with NearYou, a local exploration app built with Expo and React Native that helps users discover nearby places of interest and earn points for exploring their city.
1

Prerequisites

Before you begin, ensure you have the following installed:
  • Node.js (version 16 or higher)
  • npm or yarn package manager
  • Expo Go app on your mobile device (iOS | Android)
For iOS development on a simulator, you’ll need Xcode installed on macOS. For Android development, you’ll need Android Studio.
2

Clone the repository

Clone the NearYou repository to your local machine:
git clone https://github.com/your-username/nearyou.git
cd nearyou
3

Install dependencies

Install all required dependencies using your preferred package manager:
npm install
This will install all dependencies including:
  • Expo SDK ~54.0
  • React Native 0.81.5
  • Expo Router for navigation
  • React Navigation components
  • UI libraries and utilities
4

Start the development server

Launch the Expo development server:
npx expo start
This will open Expo Developer Tools in your browser and display a QR code in your terminal.
5

Run the app

Choose how you want to run the app:
  1. Open the Expo Go app on your phone
  2. Scan the QR code displayed in your terminal or browser
  3. Wait for the app to load
6

Explore the app

Once the app loads, you’ll see the welcome screen with three main sections:
  • Step 1: Try it - Edit app/(tabs)/index.tsx to see live changes
  • Step 2: Explore - Tap the Explore tab to learn about the starter features
  • Step 3: Get a fresh start - Run npm run reset-project when ready to build
Press cmd + d (iOS) or cmd + m (Android) to open developer tools and access features like reloading, debugging, and performance monitoring.

Next Steps

Now that you have NearYou running, here’s what to do next:

Configure the app

Learn about project structure and configuration options

Start building

Understand the codebase and start customizing

Deploy your app

Build and publish to app stores

API Reference

Explore available components and utilities

Development Commands

Here are the essential commands you’ll use during development:
CommandDescription
npm startStart the Expo development server
npm run androidOpen the app on Android emulator
npm run iosOpen the app on iOS simulator
npm run webOpen the app in web browser
npm run lintRun ESLint to check code quality
npm run reset-projectReset to a fresh project structure

Getting Help

If you encounter any issues during setup, check out our troubleshooting guide or reach out to the community.

Build docs developers (and LLMs) love