reactjs / react.dev

The React documentation website
https://react.dev/
Creative Commons Attribution 4.0 International
11.08k stars 7.55k forks source link

Improve local development instructions in the tutorial #1658

Open krichter722 opened 5 years ago

krichter722 commented 5 years ago

I'm trying to get started with the easiest example from the tutorial at https://reactjs.org/tutorial/tutorial.html#setup-for-the-tutorial for some hours now. I desperately looking for the location where to put the ShoppingList, Square`, etc. classes. I invested some time in understanding the terms, but it always falls back to the contradiction in the instructions

Delete all files in the src/ folder of the new project

and

Note: Don’t delete the entire src folder, just the original source files inside it. We’ll replace the default source files with examples for this project in the next step.

This is the same as

Delete the original source files in src.

right (where the attribute original is still unclear because all files are original after creating the app with npx)? If not, I'm not getting it after reading it the fifth time.

Furthermore, I don't find any instructions where to put the code in the tutorial. My only guess is src/index.js, but that doesn't lead to the code being displayed after npm start.

I think that creating the app with content and then deleting it is a worse approach than build the application from scratch. Unfortunately, dependencies and tools like package managers seem to be already designed more as soon-to-be outdated rather than doing one good job for a long time in the "frontend world" - which is why most other tutorials on React going the way to build from scratch are outdated these days. The solution for this problem would be to simply put the tutorial commands in a CI script and test them periodically.

ahtee commented 5 years ago

ShoppingList, Square, Block, etc will be but in src/ folder, each with their own .js file (ShoppingList.js, Square.js, Block.js), the more components you make, you can create a folder in src/ called whatever you want and further organize, you would only have to update import paths then.

index.js will always render to index.html's #root id and will import Component.js in index.js you will have your ReactDOM.render(, document.getElementById('root'));

I typically use facebook/create-react-app as a boilerplate for react projects (live-reload, etc.)