Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for React Native #2733

Closed
AmasiaNalbandian opened this issue Jan 25, 2022 · 3 comments
Closed

Documentation for React Native #2733

AmasiaNalbandian opened this issue Jan 25, 2022 · 3 comments
Assignees
Labels
type: documentation (docs) Improvements or additions to documentation type: enhancement New feature or request
Milestone

Comments

@AmasiaNalbandian
Copy link
Contributor

What would you like to be added:

  1. How we run the code
  2. Basic idea of how it works
  3. Navigation - Where is the code?
  4. Link to the packages used
  5. Testing documentation, if exists (if not we need to add, create issue please)
  6. Link to the wiki

please get a review from someone who has not worked in this area.

Why would you like this to be added:

@AmasiaNalbandian AmasiaNalbandian added type: documentation (docs) Improvements or additions to documentation type: enhancement New feature or request labels Jan 25, 2022
@AmasiaNalbandian AmasiaNalbandian added this to the 2.6 Release milestone Jan 25, 2022
@LuigiZaccagnini
Copy link
Contributor

LuigiZaccagnini commented Jan 26, 2022

Just providing some information that can help with the documentation.

React Native Documentation

Installing React Native Expo

Installing the command line tool so you can run Expo commands.
npm install --global expo-cli

How to run the code?

To start a development server to start testing code you would run expo start and in your terminal a QR code will pop up. You will need to install the Expo GO app on your phone to scan and install the app for development.

Navigation - Where is the code?


With the starting off React Native code, App.js is the root file with all the components. Think of it like an Index.html. This is where navigation code would go or if it is a single page app, all of the components. App.json has the information about our app (Name, splash image, etc.). As we get more into development this part of the documentation will change a lot.

Link to the packages used

Expo

@humphd
Copy link
Contributor

humphd commented Jan 26, 2022

Is it possible to use expo-cli without having it installed globally? Can we install it as a devDependency, and then write npm scripts to call the version in node_modules/.bin?

@tpmai22
Copy link
Contributor

tpmai22 commented Feb 13, 2022

#2841

@tpmai22 tpmai22 closed this as completed Feb 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation (docs) Improvements or additions to documentation type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

8 participants