Installation Guide

Follow these steps to set up the project on your local machine and start building.

Requirements

First make sure you have the following tools installed on your machine:

React Native dev environment
Node.js LTS release
Git
Watchman, required only for macOS or Linux users
Pnpm
Cursor is recommended but you can use VS Code Editor.

Step 1: Initialize Project

First make sure you have pnpm installed on your machine, if not you can install it using the following command:

1npm install -g pnpm

Run the interactive CLI to create a new project. You will be guided through setting up your project name, selecting a template, and configuring AI agents.

1npx create-twinbloc-app@latest

Interactive Configuration:

Project Name: Define your app's name
Template Variant: Choose 'Base' or select from available examples
Agent Configs: Pre-configure settings for AI tools like VS Code, Cursor, Windsurf, Trae, and more

Package Naming Tip

When naming your project, remember that it must comply with Android package conventions. Key requirements include:

Must contain at least two segments (e.g., com.myapp)
Each segment must begin with a letter
Only alphanumeric characters and underscores are allowed

Step 2: Install Dependencies

The CLI will ask if you want to install dependencies automatically. If you choose Yes, you can skip this step.

If you chose No, navigate to your project directory and install dependencies manually:

1cd <project-name>

1# Using pnpm (Recommended)
2pnpm install
3
4# Using npm
5npm install
6
7# Using yarn
8yarn install

Step 3: Run the App

Since this template includes native modules, you should run the prebuild command or use the run commands which handle prebuilding automatically.

Native Dependencies & Expo Go

This template utilizes native code, which means it is not compatible with the standard Expo Go app. To run the project, you'll need to build the custom development client on your simulator or physical device using the commands below.

1# Run on iOS Simulator
2npm run ios
3
4# Run on Android Emulator
5npm run android

Twinbloc Studios