Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add README to RN Template App, added when `npx react-native@latest init <AppName>` by Pranav-yadav · Pull Request #37521 · react/react-native · GitHub
Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add README to RN Template App, added when `npx react-native@latest init <AppName>` by Pranav-yadav · Pull Request #37521 · react/react-native · GitHub
Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add README to RN Template App, added when `npx react-native@latest init <AppName>` by Pranav-yadav · Pull Request #37521 · react/react-native · GitHub
Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' Add README to RN Template App, added when `npx react-native@latest init <AppName>` by Pranav-yadav · Pull Request #37521 · react/react-native · GitHub
Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add README to RN Template App, added when `npx react-native@latest init <AppName>` by Pranav-yadav · Pull Request #37521 · react/react-native · GitHub
Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' Add README to RN Template App, added when `npx react-native@latest init <AppName>` by Pranav-yadav · Pull Request #37521 · react/react-native · GitHub
Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); Add README to RN Template App, added when `npx react-native@latest init <AppName>` by Pranav-yadav · Pull Request #37521 · react/react-native · GitHub
Skip to content

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

Closed
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template
Closed

Add README to RN Template App, added when npx react-native@latest init <AppName>#37521
Pranav-yadav wants to merge 1 commit into
react:mainfrom
Pranav-yadav:Pranav-yadav/readme-for-template

Conversation

@Pranav-yadav

@Pranav-yadavPranav-yadav commented May 22, 2023

Copy link
Copy Markdown
Contributor

Summary:

I noticed that; when a new RN App is created using RN CLI there is NOREADME 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: react/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

@facebook-github-botfacebook-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
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@cortinico WDYT?

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

Cc: @kelset

@Pranav-yadavPranav-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
@analysis-bot

analysis-bot commented May 22, 2023

Copy link
Copy Markdown
PlatformEngineArchSize (bytes)Diff
androidhermesarm64-v8a8,757,669+0
androidhermesarmeabi-v7a8,070,239+3
androidhermesx869,250,265+0
androidhermesx86_649,099,405-1
androidjscarm64-v8a9,318,872+2
androidjscarmeabi-v7a8,508,773+0
androidjscx869,382,363+2
androidjscx86_649,635,606-1

Base commit: be34852
Branch: main

@cipolleschicipolleschi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadpackages/react-native/template/README.md Outdated
@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch 2 times, most recently from 2503f10 to 955998dCompareMay 22, 2023 20:39
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

Pushed some changes, addressing feedback!
🙂

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from 955998d to 3e060f2CompareMay 23, 2023 15:33
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@kelsetkelset left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! Thanks @Pranav-yadav!

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

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

Comment threadpackages/react-native/template/README.md Outdated
@Pranav-yadav

Pranav-yadav commented Jun 13, 2023

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
Contributor

yeah I think that's ok 👍 go for it

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from f7c68b3 to eb581dfCompareJune 13, 2023 18:54
@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor

@Pranav-yadav
Pranav-yadavforce-pushed the Pranav-yadav/readme-for-template branch from eb581df to e0d3c9fCompareJune 14, 2023 15:08
cipolleschi

This comment was marked as resolved.

@facebook-github-bot

Copy link
Copy Markdown
Contributor

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

@Pranav-yadav

Copy link
Copy Markdown
ContributorAuthor
#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-botfacebook-github-bot added the Merged This PR has been merged. label Jun 14, 2023
@facebook-github-bot

Copy link
Copy Markdown
Contributor

@cipolleschi merged this pull request in 377a8b7.

@Pranav-yadav
Pranav-yadav deleted the Pranav-yadav/readme-for-template branch June 15, 2023 09:04
kelset pushed a commit that referenced this pull request Jun 28, 2023
…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: react/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
blakef pushed a commit to blakef/template that referenced this pull request Feb 28, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
blakef pushed a commit to react-native-community/template that referenced this pull request Feb 29, 2024
…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: react/react-native-website#3732 🚀😇
bypass-github-export-checks
## Changelog:
[INTERNAL] [ADDED] - Add README to RN Template App ⚡
Pull Request resolved: react/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: react/react-native@377a8b7
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA SignedThis label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.MergedThis PR has been merged.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@Pranav-yadav@analysis-bot@facebook-github-bot@kelset@cipolleschi@NickGerleman@cortinico