Prerequisites
How to configure your development environment for AppKickstarter.
Tooling Setup
Before you begin with setting up the project, ensure you have the following installed on your system:
Enable Corepack
Corepack is a package manager bootstrapper that comes with modern versions of Node.js (>=16.10). It's an official Node.js tool letting you define which package manager version you want to use on a per-project basis, just like your lockfile does for your project dependencies.
Corepack is included with all official Node.js releases starting from Node.js 14.19 / 16.9
. It's however opt-in for the duration of the experimental stage, so you'll need to run corepack enable before it's active.
We provide yarn3.4.1 in the repo already, so Corepack removes the need for you to install it yourself. This helps with ensuring consistent versions of tools, reducing unexpected behaviour.
To enable Corepack, run:
corepack enable
EAS CLI
We use the EAS CLI to handle builds, updates, and releases of the app.
npm install --global eas-cli
For Mac users
XCode and XCode Command Line Tools
- Install XCode from the Mac App Store
- Install XCode Command Line Tools:
xcode-select --install
Alternatively, you can open XCode, go to Settings (or press cmd ⌘
+ ,
). In the Locations tab, select the latest version from the Command Line Tools dropdown menu.
(Optional) iOS Simulator
Download an iOS Simulator to run & test the iOS app locally on a simulator. This is optional as you can also run it on a physical iOS device.
For Windows users
Android Studio
Download and install Android Studio to run the Android app locally on a simulator.
You will also need JDK 21 if you want to build the APK locally.
Make sure your $ANDROID_HOME
is setup correctly. When you enter echo $ANDROID_HOME
into your terminal, you should see:
/Users/your_username/Library/Android/sdk
Congrats! Now you're ready to set up the project.