Add README to RN Template App, added when `npx react-native@latest init <AppName>` #37521

Pranav-yadav · 2023-05-22T16:25:52Z

Summary:

I noticed that; when a new RN App is created using RN CLI there is NO README file added to the project.
Having a simple README file explaining what type of project it is, for example how other web projects do it, such as long lived create-react-app, now widely used create-next-app, etc.

Why not for React Native App then?

This PR; Adds README file to RN Template App ⚡, which should be added to the project when a new project is created using RN CLI.

Website PR: facebook/react-native-website#3732 🚀😇

Changelog:

[INTERNAL] [ADDED] - Add README to RN Template App ⚡

Test Plan:

The README file should be included in the newly created RN App using RN CLI

packages/react-native/template/README.md

Pranav-yadav · 2023-05-22T16:34:20Z

@cortinico WDYT?

Should we add README to RN Template App?
What extra sections need to be added?
What should be removed? (I would say the "Learn More" section should short and simple)

Cc: @kelset

analysis-bot · 2023-05-22T16:49:14Z

Platform	Engine	Arch	Size (bytes)	Diff
android	hermes	arm64-v8a	8,757,669	+0
android	hermes	armeabi-v7a	8,070,239	+3
android	hermes	x86	9,250,265	+0
android	hermes	x86_64	9,099,405	-1
android	jsc	arm64-v8a	9,318,872	+2
android	jsc	armeabi-v7a	8,508,773	+0
android	jsc	x86	9,382,363	+2
android	jsc	x86_64	9,635,606	-1

Base commit: be34852
Branch: main

cipolleschi

Thanks for taking the time for this. I left a comment on iOS as we should support explicitly both platforms! 😉

packages/react-native/template/README.md

facebook-github-bot · 2023-05-22T17:15:45Z

@cipolleschi has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

Pranav-yadav · 2023-05-22T20:43:53Z

Pushed some changes, addressing feedback!
🙂

packages/react-native/template/README.md

Pranav-yadav · 2023-05-24T06:05:50Z

Basis, discussion above, also opened react-native-website PR: facebook/react-native-website#3732

Pranav-yadav · 2023-05-24T12:05:18Z

Rendered View 😊: https://github.com/Pranav-yadav/react-native/blob/Pranav-yadav/readme-for-template/packages/react-native/template/README.md

kelset

Great work! Thanks @Pranav-yadav!

Pranav-yadav · 2023-05-26T11:39:56Z

Note: I'll be taking a break, since finished with exams and haven't taken one in a while 😅.
I've "Allowed edits by maintainers". So, please feel free to suggest and commit changes as you feel right.
Thanks for reviewing and providing feedback.

facebook-github-bot · 2023-05-29T14:02:50Z

@cipolleschi has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

packages/react-native/template/README.md

Pranav-yadav · 2023-06-13T05:59:30Z

As Nick mentioned about the npm option available in the RN CLI under the website PR,
So, I think instead of coming up with some another way to tackle that, it would be great if we could just provide both npm run and yarn commands for each step, like:
e.g.:

--

For Android:

# using npm
npm run android

# OR using yarn
yarn android

For iOS:

# using npm
npm run ios

# OR using yarn
yarn ios

--

@NickGerleman @kelset WDYT?

kelset · 2023-06-13T09:25:26Z

yeah I think that's ok 👍 go for it

Pranav-yadav · 2023-06-13T19:01:34Z

Done. 🚀
Rendered View: https://github.com/Pranav-yadav/react-native/blob/Pranav-yadav/readme-for-template/packages/react-native/template/README.md

facebook-github-bot · 2023-06-14T15:16:50Z

@cipolleschi has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

Pranav-yadav · 2023-06-14T15:26:28Z

#offtopic :) 👇

Looks like I discovered a bug in GitHub's frontend logic 😃
When I was replying to Riccardo's (requested changes comment), he deleted the comment and when I clicked on comment/post, GitHub started a review on my behalf which can be seen above 🤔 or maybe it's possible that someone else did it 👀 or I'm thinking tooooo much about GitHub and OSS stuff these days 🤣.

facebook-github-bot · 2023-06-14T17:41:14Z

@cipolleschi merged this pull request in 377a8b7.

…it <AppName>` (#37521) Summary: [skip-ci] I noticed that; when a _new_ RN App is created using RN CLI there is ***NO*** *README* file added to the project. Having a simple README file explaining what type of project it is, for example how other web projects do it, such as long lived `create-react-app`, now widely used `create-next-app`, etc. Why not for React Native App then? This PR; Adds README file to RN Template App ⚡, which should be added to the project when a new project is created using RN CLI. ### Website PR: facebook/react-native-website#3732 🚀😇 bypass-github-export-checks ## Changelog: [INTERNAL] [ADDED] - Add README to RN Template App ⚡ Pull Request resolved: #37521 Test Plan: - The README file should be included in the newly created RN App using RN CLI Reviewed By: NickGerleman Differential Revision: D46075719 Pulled By: cipolleschi fbshipit-source-id: efcccc09d72c57a065b36de6e787594082000e15

…it <AppName>` (#37521) Summary: [skip-ci] I noticed that; when a _new_ RN App is created using RN CLI there is ***NO*** *README* file added to the project. Having a simple README file explaining what type of project it is, for example how other web projects do it, such as long lived `create-react-app`, now widely used `create-next-app`, etc. Why not for React Native App then? This PR; Adds README file to RN Template App ⚡, which should be added to the project when a new project is created using RN CLI. ### Website PR: facebook/react-native-website#3732 🚀😇 bypass-github-export-checks ## Changelog: [INTERNAL] [ADDED] - Add README to RN Template App ⚡ Pull Request resolved: facebook/react-native#37521 Test Plan: - The README file should be included in the newly created RN App using RN CLI Reviewed By: NickGerleman Differential Revision: D46075719 Pulled By: cipolleschi fbshipit-source-id: efcccc09d72c57a065b36de6e787594082000e15 Original: facebook/react-native@377a8b7

…it <AppName>` (#37521) Summary: [skip-ci] I noticed that; when a _new_ RN App is created using RN CLI there is ***NO*** *README* file added to the project. Having a simple README file explaining what type of project it is, for example how other web projects do it, such as long lived `create-react-app`, now widely used `create-next-app`, etc. Why not for React Native App then? This PR; Adds README file to RN Template App ⚡, which should be added to the project when a new project is created using RN CLI. ### Website PR: facebook/react-native-website#3732 🚀😇 bypass-github-export-checks ## Changelog: [INTERNAL] [ADDED] - Add README to RN Template App ⚡ Pull Request resolved: facebook/react-native#37521 Test Plan: - The README file should be included in the newly created RN App using RN CLI Reviewed By: NickGerleman Differential Revision: D46075719 Pulled By: cipolleschi fbshipit-source-id: efcccc09d72c57a065b36de6e787594082000e15 Original-Commit: facebook/react-native@377a8b7

facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label May 22, 2023

cortinico reviewed May 22, 2023

View reviewed changes

packages/react-native/template/README.md Outdated Show resolved Hide resolved

Pranav-yadav changed the title ~~Add README to RN Template App ⚡~~ Add README to RN Template App, added when npx react-native@latest init <AppName> May 22, 2023

cipolleschi approved these changes May 22, 2023

View reviewed changes

packages/react-native/template/README.md Outdated Show resolved Hide resolved

Pranav-yadav force-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998d Compare May 22, 2023 20:39

kelset reviewed May 23, 2023

View reviewed changes

packages/react-native/template/README.md Outdated Show resolved Hide resolved

Pranav-yadav force-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2 Compare May 23, 2023 15:33

NickGerleman requested changes May 23, 2023

View reviewed changes

Pranav-yadav force-pushed the Pranav-yadav/readme-for-template branch from 3e060f2 to f7c68b3 Compare May 23, 2023 19:17

Pranav-yadav requested a review from NickGerleman May 24, 2023 04:04

Pranav-yadav mentioned this pull request May 24, 2023

[FEAT] Separate Tabs for npm run and yarn commands facebook/react-native-website#3732

Merged

Pranav-yadav requested a review from cipolleschi May 24, 2023 11:57

kelset approved these changes May 24, 2023

View reviewed changes

NickGerleman approved these changes May 24, 2023

View reviewed changes

NickGerleman reviewed May 30, 2023

View reviewed changes

packages/react-native/template/README.md Show resolved Hide resolved

Pranav-yadav force-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581df Compare June 13, 2023 18:54

Pranav-yadav requested a review from NickGerleman June 13, 2023 18:58

Pranav-yadav requested a review from cortinico June 13, 2023 19:11

Pranav-yadav force-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9f Compare June 14, 2023 15:08

This comment was marked as resolved.

Sign in to view

cipolleschi approved these changes Jun 14, 2023

View reviewed changes

facebook-github-bot closed this in 377a8b7 Jun 14, 2023

facebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023

Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04

NOUIY mentioned this pull request Jul 21, 2023

[Snyk] Upgrade react-native from 0.63.3 to 0.72.1 NOUIY/react-native-macos#1107

Open

This was referenced Aug 10, 2023

[LOCAL] Fix Ruby Tests for 0.72 #38919

Closed

[LOCAL] Add script poll maven #38980

Merged

cipolleschi mentioned this pull request Sep 21, 2023

[LOCAL] Copy hermes ruby files to hermes folder in local E2E test #39575

Merged

cipolleschi mentioned this pull request Oct 12, 2023

[Local] Fix CI for 0.72, with Acitve Support and Xcode15 #40855

Merged

cipolleschi mentioned this pull request Nov 1, 2023

[RN][CI]Update node installation on debian (0.72) #41276

Merged

stevenpetryk mentioned this pull request Nov 28, 2023

Avoid using Xcode 15's gcc when compiling glog discord/react-native#48

Merged

cipolleschi mentioned this pull request Dec 27, 2023

[RN][iOS] Improve Swift support for 3rd party libs #42075

Merged

This was referenced Feb 28, 2024

[RN][IOS] Fix flags for new arch #43240

Merged

[RN][iOS]Rename BUILD_FROM_SOURCE to RCT_BUILD_HERMES_FROM_SOURCE #43247

Merged

cipolleschi mentioned this pull request Mar 6, 2024

[RN][iOS][0.72] Fix flipper for Xcode 15.3 #43344

Merged

cipolleschi mentioned this pull request Jun 28, 2024

[CI] Move machines to M1 for 0.72 #45215

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add README to RN Template App, added when `npx react-native@latest init <AppName>` #37521

Add README to RN Template App, added when `npx react-native@latest init <AppName>` #37521

Pranav-yadav commented May 22, 2023 •

edited

Loading

Pranav-yadav commented May 22, 2023

analysis-bot commented May 22, 2023 •

edited

Loading

cipolleschi left a comment

facebook-github-bot commented May 22, 2023

Pranav-yadav commented May 22, 2023

Pranav-yadav commented May 24, 2023

Pranav-yadav commented May 24, 2023

kelset left a comment

Pranav-yadav commented May 26, 2023

facebook-github-bot commented May 29, 2023

Pranav-yadav commented Jun 13, 2023 •

edited

Loading

kelset commented Jun 13, 2023

Pranav-yadav commented Jun 13, 2023

This comment was marked as resolved.

facebook-github-bot commented Jun 14, 2023

Pranav-yadav commented Jun 14, 2023

facebook-github-bot commented Jun 14, 2023

Add README to RN Template App, added when npx react-native@latest init <AppName> #37521

Add README to RN Template App, added when npx react-native@latest init <AppName> #37521

Conversation

Pranav-yadav commented May 22, 2023 • edited Loading

Summary:

Website PR: facebook/react-native-website#3732 🚀😇

Changelog:

Test Plan:

Pranav-yadav commented May 22, 2023

analysis-bot commented May 22, 2023 • edited Loading

cipolleschi left a comment

Choose a reason for hiding this comment

facebook-github-bot commented May 22, 2023

Pranav-yadav commented May 22, 2023

Pranav-yadav commented May 24, 2023

Pranav-yadav commented May 24, 2023

kelset left a comment

Choose a reason for hiding this comment

Pranav-yadav commented May 26, 2023

facebook-github-bot commented May 29, 2023

Pranav-yadav commented Jun 13, 2023 • edited Loading

kelset commented Jun 13, 2023

Pranav-yadav commented Jun 13, 2023

This comment was marked as resolved.

facebook-github-bot commented Jun 14, 2023

Pranav-yadav commented Jun 14, 2023

facebook-github-bot commented Jun 14, 2023

Add README to RN Template App, added when `npx react-native@latest init <AppName>` #37521

Add README to RN Template App, added when `npx react-native@latest init <AppName>` #37521

Pranav-yadav commented May 22, 2023 •

edited

Loading

analysis-bot commented May 22, 2023 •

edited

Loading

Pranav-yadav commented Jun 13, 2023 •

edited

Loading