Skip to content

FaisalKhawaj/ReactNativeBoilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a new React Native project, bootstrapped using @react-native-community/cli.

Making new project from this boilerplate with your new project name and a new bundleIdentifier

Note: I had create-project.sh in dev-scripts folder ,so you can create dev-scripts folder and can add create-project.sh in that folder.

You need to create a script file (create-project.sh)

touch create-project.sh

Note: This is for MacOS users

You need to write below lines in that script file(create-project.sh)

if [ "$#" -ne 2 ]; then
    echo "Usage: $0 <NewProjectName> <BundleIdentifier>"
    exit 1
fi

PROJECT_NAME=$1
BUNDLE_IDENTIFIER=$2

REPO_URL="git@github.com:FaisalKhawaj/ReactNativeBoilerplate.git"

git clone $REPO_URL $PROJECT_NAME


cd $PROJECT_NAME


npm install


npx react-native-rename $PROJECT_NAME -b $BUNDLE_IDENTIFIER


if [ $? -ne 0 ]; then
  echo "Failed to rename project"
  exit 1
fi

rm -rf .git
git init
git add .
git commit -m "Initial commit for $PROJECT_NAME"

if [ $? -ne 0 ]; then
  echo "Failed to rename project"
  exit 1
fi


echo "Project $PROJECT_NAME created successfully"

Run the following command to make the script executable:

chmod +x create-new-project.sh

In order to clone this boilerplate with your ProjectName and bundle identifier, you need to run this command with name of your project instead of YourAppName and bundleIdentifer instead of com.your.bundle.identifier

~/dev-scripts/create-new-project.sh YourAppName com.your.bundle.identifier

Getting Started

Note: Make sure you have completed the React Native - Environment Setup instructions till "Creating a new application" step, before proceeding.

Step 1: install packages

npm install

Step 2: Start the Metro Server

First, you will need to start Metro, the JavaScript bundler that ships with React Native.

To start Metro, run the following command from the root of your React Native project:

# using npm
npm start

# OR using Yarn
yarn start

Step 3: Start your Application

Let Metro Bundler run in its own terminal. Open a new terminal from the root of your React Native project. Run the following command to start your Android or iOS app:

For Android

# using npm
npm run android

# OR using Yarn
yarn android

For iOS

# using npm
npm run ios

# OR using Yarn
yarn ios

If everything is set up correctly, you should see your new app running in your Android Emulator or iOS Simulator shortly provided you have set up your emulator/simulator correctly.

This is one way to run your app — you can also run it directly from within Android Studio and Xcode respectively.

Step 4: Modifying your App

Now that you have successfully run the app, let's modify it.

  1. Open App.tsx in your text editor of choice and edit some lines.

  2. For Android: Press the R key twice or select "Reload" from the Developer Menu (Ctrl + M (on Window and Linux) or Cmd ⌘ + M (on macOS)) to see your changes!

    For iOS: Hit Cmd ⌘ + R in your iOS Simulator to reload the app and see your changes!

Congratulations! 🎉

You've successfully run and modified your React Native App. 🥳

Now what?

Troubleshooting

If you can't get this to work, see the Troubleshooting page.

Learn More

To learn more about React Native, take a look at the following resources: