Skip to content

Commit fe932b6

Browse files
committed
doc: Add foundational project documentation
Turns the README into a nice landing page for the project. Creates a CONTRIBUTING guide with setup instructions. Adds a LICENSE for the legal side.
1 parent 6c1fad2 commit fe932b6

File tree

4 files changed

+543
-49
lines changed

4 files changed

+543
-49
lines changed

CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
2+
# Contributing
3+
4+
>**Note**: Make sure you have completed the [React Native - Environment Setup](https://reactnative.dev/docs/environment-setup) instructions till "Creating a new application" step, before proceeding.
5+
6+
## Step 1: Start the Metro Server
7+
8+
First, you will need to start **Metro**, the JavaScript _bundler_ that ships _with_ React Native.
9+
10+
To start Metro, run the following command from the _root_ of your React Native project:
11+
12+
```bash
13+
# using npm
14+
npm start
15+
16+
# OR using Yarn
17+
yarn start
18+
```
19+
20+
## Step 2: Start your Application
21+
22+
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:
23+
24+
### For Android
25+
26+
```bash
27+
# using npm
28+
npm run android
29+
30+
# OR using Yarn
31+
yarn android
32+
```
33+
34+
If everything is set up _correctly_, you should see your new app running in your _Android Emulator_ shortly provided you have set up your emulator/simulator correctly.
35+
36+
This is one way to run your app — you can also run it directly from within Android Studio.
37+
38+
## Step 3: Modifying your App
39+
40+
Now that you have successfully run the app, let's modify it.
41+
42+
1. Open `App.tsx` in your text editor of choice and edit some lines.
43+
2. For **Android**: Press the <kbd>R</kbd> key twice or select **"Reload"** from the **Developer Menu** (<kbd>Ctrl</kbd> + <kbd>M</kbd> (on Window and Linux) or <kbd>Cmd ⌘</kbd> + <kbd>M</kbd> (on macOS)) to see your changes!
44+
45+
## Congratulations! :tada:
46+
47+
You've successfully run and modified your React Native App. :partying_face:
48+
49+
### Now what?
50+
51+
- If you want to add this new React Native code to an existing application, check out the [Integration guide](https://reactnative.dev/docs/integration-with-existing-apps).
52+
- If you're curious to learn more about React Native, check out the [Introduction to React Native](https://reactnative.dev/docs/getting-started).
53+
54+
# Troubleshooting
55+
56+
If you can't get this to work, see the [Troubleshooting](https://reactnative.dev/docs/troubleshooting) page.
57+
58+
# Learn More
59+
60+
To learn more about React Native, take a look at the following resources:
61+
62+
- [React Native Website](https://reactnative.dev) - learn more about React Native.
63+
- [Getting Started](https://reactnative.dev/docs/environment-setup) - an **overview** of React Native and how setup your environment.
64+
- [Learn the Basics](https://reactnative.dev/docs/getting-started) - a **guided tour** of the React Native **basics**.
65+
- [Blog](https://reactnative.dev/blog) - read the latest official React Native **Blog** posts.
66+
- [`@facebook/react-native`](https://github.com/facebook/react-native) - the Open Source; GitHub **repository** for React Native.

0 commit comments

Comments
 (0)