Skip to content

sst-product-team/sst-app

Repository files navigation

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

Getting Started

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

Step 1: 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 2: 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.

Contributor Guidelines

Thank you for contributing to our React Native project! Before you submit a pull request, please follow these guidelines:

1. Use react-native-paper Material UI

Make sure to utilize react-native-paper for Material UI components in this project. It provides a set of high-quality React Native components following Material Design guidelines.

2. Code Formatting and Linting

Before creating a pull request, ensure that your code is properly formatted and linted. Use the following commands:

# Format code
npm run format

# Lint code
npm run lint

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: