From 623523131e11a9c08ce01130e612f366d58b5ea1 Mon Sep 17 00:00:00 2001 From: Dan Abramov Date: Tue, 26 Jun 2018 01:24:56 +0100 Subject: [PATCH] Rewrite Installation and related docs (#996) * Rewrite "adding React to existing app" Fixes #988 * Some copy * typo * Update babel instructions * Update umd link * Add prod minification section * Show "button" example in several targets * wip * More * More * tweak * yas * Multi root tip * moaar * alot * Tweak links * Explain better * better lead * tweaks * tweaks * wording * More reassuring tone * Grammar * wording * feedback from readers * Use id, not class * More nits * Re-add a useful section --- content/docs/add-react-to-a-new-app.md | 54 ------ content/docs/add-react-to-a-website.md | 181 +++++++++++++++++++ content/docs/add-react-to-an-existing-app.md | 96 ---------- content/docs/cdn-links.md | 4 +- content/docs/create-a-new-react-app.md | 93 ++++++++++ content/docs/getting-started.md | 105 +++++++++++ content/docs/hello-world.md | 6 - content/docs/nav.yml | 12 +- content/docs/try-react.md | 41 ----- content/tutorial/tutorial.md | 12 +- src/components/LayoutHeader/Header.js | 2 +- src/pages/index.js | 4 +- 12 files changed, 400 insertions(+), 210 deletions(-) delete mode 100644 content/docs/add-react-to-a-new-app.md create mode 100644 content/docs/add-react-to-a-website.md delete mode 100644 content/docs/add-react-to-an-existing-app.md create mode 100644 content/docs/create-a-new-react-app.md create mode 100644 content/docs/getting-started.md delete mode 100644 content/docs/try-react.md diff --git a/content/docs/add-react-to-a-new-app.md b/content/docs/add-react-to-a-new-app.md deleted file mode 100644 index 14e011af..00000000 --- a/content/docs/add-react-to-a-new-app.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -id: add-react-to-a-new-app -title: Add React to a New Application -permalink: docs/add-react-to-a-new-app.html -prev: try-react.html -next: add-react-to-an-existing-app.html ---- - -The easiest way to get started on a new React project is by using a starter kit. - -> Note: -> -> This page describes setting up a single-page application with everything you need for a comfortable development workflow, including linting, testing, production optimizations, and more. Full-featured tools like these require some time and disk space to install. -> ->If you are looking for a lightweight environment to experiment with React, check out the [Try React](/docs/try-react.html) page instead. **A [single HTML file](https://raw.githubusercontent.com/reactjs/reactjs.org/master/static/html/single-file-example.html) is enough to get you started!** -> -> Finally, if you're not building a single-page application, you can either [add React to your existing build pipeline](/docs/add-react-to-an-existing-app.html) or [use it from CDN](/docs/cdn-links.html) and [without a build step](/docs/react-without-jsx.html). - -## Create React App - -[Create React App](http://github.com/facebookincubator/create-react-app) is the best way to start building a new React single page application. It sets up your development environment so that you can use the latest JavaScript features, provides a nice developer experience, and optimizes your app for production. You’ll need to have Node >= 6 on your machine. - -```bash -npm install -g create-react-app -create-react-app my-app - -cd my-app -npm start -``` - -If you have npm 5.2.0+ installed, you may use [npx](https://www.npmjs.com/package/npx) instead. - -```bash -npx create-react-app my-app - -cd my-app -npm start -``` - -Create React App doesn't handle backend logic or databases; it just creates a frontend build pipeline, so you can use it with any backend you want. It uses build tools like [Babel](http://babeljs.io/) and [webpack](https://webpack.js.org/) under the hood, but works with zero configuration. - -When you're ready to deploy to production, running `npm run build` will create an optimized build of your app in the `build` folder. You can learn more about Create React App [from its README](https://github.com/facebookincubator/create-react-app#create-react-app-) and the [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#table-of-contents). - -## Other Starter Kits - -We have created [a curated list of third-party starter kits that we officially recommend](/community/starter-kits.html). - -They slightly differ in their focus but are all production-ready, well-maintained, and don't require configuration to get started. - -You can also check out a list of [other kits](/community/starter-kits.html#other-starter-kits) contributed by the community. - -## Advanced - -If you prefer to configure a project manually, see [Installing React](/docs/add-react-to-an-existing-app.html#installing-react) in the next section. diff --git a/content/docs/add-react-to-a-website.md b/content/docs/add-react-to-a-website.md new file mode 100644 index 00000000..2cafc2ea --- /dev/null +++ b/content/docs/add-react-to-a-website.md @@ -0,0 +1,181 @@ +--- +id: add-react-to-a-website +title: Add React to a Website +permalink: docs/add-react-to-a-website.html +redirect_from: "docs/add-react-to-an-existing-app.html" +prev: getting-started.html +next: create-a-new-react-app.html +--- + +Use as little or as much React as you need. + +React is designed for gradual adoption, and **you can use as little or as much React as you need**. Perhaps you only want to add some "sprinkles of interactivity" to an existing page. React components are a great way to do that. + +The majority of websites aren't, and don't need to be, single-page apps. With **a few lines of code and no build tooling**, try React in a small part of your website. You can then either gradually expand its presence, or keep it contained to a few dynamic widgets. + +--- + +- [Add React in One Minute](#add-react-in-one-minute) +- [Optional: Try React with JSX](#optional-try-react-with-jsx) + +## Add React in One Minute + +In this section, we will show how to add a React component to an existing HTML page. You can follow along with your own website, or create an empty HTML file to practice. + +There will be no complicated tools or install requirements -- **to complete this section, you only need an internet connection, and a minute of your time.** + +Optional: [Download the full example (2KB zipped)](https://gist.github.com/gaearon/6668a1f6986742109c00a581ce704605/archive/f6c882b6ae18bde42dcf6fdb751aae93495a2275.zip) + +### Step 1: Add a DOM Container to the HTML + +First, open the HTML page you want to edit. Add an empty `
` tag to mark the spot where you want to display something with React. For example: + +```html{3} + + +
+ + +``` + +We gave this `
` a unique `id` HTML attribute. This will allow us to find it from the JavaScript code later and display a React component inside of it. + +>Tip +> +>You can place a "container" `
` like this **anywhere** inside the `` tag. You may have as many independent DOM containers on one page as you need. They are usually empty -- React will replace any existing content inside DOM containers. + +### Step 2: Add the Script Tags + +Next, add three ` + + + + + + +``` + +The first two tags load React. The third one will load your component code. + +### Step 3: Create a React Component + +Create a file called `like_button.js` next to your HTML page. + +Open this [this starter code](https://cdn.rawgit.com/gaearon/0b180827c190fe4fd98b4c7f570ea4a8/raw/b9157ce933c79a4559d2aa9ff3372668cce48de7/LikeButton.js) and paste it into the file you created. + +>Tip +> +>This code defines a React component called `LikeButton`. Don't worry if you don't understand it yet -- we'll cover the building blocks of React later in our [main concepts guide](/docs/hello-world.html) and a [hands-on tutorial](/tutorial/tutorial.html). For now, let's just get it showing on the screen! + +After the starter code, add two lines to the bottom of `like_button.js`: + +```js{3,4} +// ... the starter code you pasted ... + +const domContainer = document.querySelector('#like_button_container'); +ReactDOM.render(e(LikeButton), domContainer); +``` + +These two lines of code find the `
` we added to our HTML in the first step, and then display our "Like" button React component inside of it. + +### That's It! + +There is no step four. **You have just added the first React component to your website.** + +Check out the next sections for more tips on integrating React. + +**[View the full example source code](https://gist.github.com/gaearon/6668a1f6986742109c00a581ce704605)** + +**[Download the full example (2KB zipped)](https://gist.github.com/gaearon/6668a1f6986742109c00a581ce704605/archive/f6c882b6ae18bde42dcf6fdb751aae93495a2275.zip)** + +### Tip: Reuse a Component + +Commonly, you might want to display React components in multiple places on the HTML page. Here is an example that displays the "Like" button three times and passes some data to it: + +[View the full example source code](https://gist.github.com/gaearon/faa67b76a6c47adbab04f739cba7ceda) + +[Download the full example (2KB zipped)](https://gist.github.com/gaearon/faa67b76a6c47adbab04f739cba7ceda/archive/9d0dd0ee941fea05fd1357502e5aa348abb84c12.zip) + +>Note +> +>This strategy is mostly useful while React-powered parts of the page are isolated from each other. Inside React code, it's easier to use [component composition](/docs/components-and-props.html#composing-components) instead. + +### Tip: Minify JavaScript for Production + +Before deploying your website to production, be mindful that unminifed JavaScript can significantly slow down the page for your users. + +If you already minify the application scripts, **your site will be production-ready if you ensure that the deployed HTML loads the versions of React ending in `production.min.js`:** + +```js + + +``` + +If you don't have a minification step for your scripts, [here's one way to set it up](https://gist.github.com/gaearon/42a2ffa41b8319948f9be4076286e1f3). + +## Optional: Try React with JSX + +In the examples above, we only relied on features that are natively supported by the browsers. This is why we used a JavaScript function call to tell React what to display: + +```js +const e = React.createElement; + +// Display a "Like" +); +``` + +These two code snippets are equivalent. While **JSX is [completely optional](/docs/react-without-jsx.html)**, many people find it helpful for writing UI code -- both with React and with other libraries. + +You can play with JSX using [this online converter](http://babeljs.io/repl#?babili=false&browsers=&build=&builtIns=false&spec=false&loose=false&code_lz=Q&debug=false&forceAllTransforms=false&shippedProposals=false&circleciRepo=&evaluate=false&fileSize=false&sourceType=module&lineWrap=true&presets=es2015%2Creact%2Cstage-2%2Cstage-3&prettier=true&targets=Node-6.12&version=6.26.0&envVersion=). + +### Add JSX to a Project + +If you want to add JSX to your project, follow these three steps: + +1. [Install Node.js](https://nodejs.org/) +2. **Don't miss this step:** Run `npm init -y` in your project folder +3. Run `npm install babel-cli@6 babel-preset-react-app@3` + +You can now use JSX! + +### Compile JSX with One Command + +Create create a folder called `src` and run this terminal command: + +``` +npx babel --watch src --out-dir . --presets react-app/prod +``` + +>Note +> +>`npx` is not a typo -- it's a [package runner tool that comes with npm 5.2+](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b). +> +>If you see an error message saying "You have mistakingly installed the `babel` package", you might have missed [the previous step](#add-jsx-to-a-project). Perform it in the same folder, and then try again. + +This command starts an automated watcher for JSX. For example, if you create `src/like_button.js` with this [JSX starter code](https://cdn.rawgit.com/gaearon/c8e112dc74ac44aac4f673f2c39d19d1/raw/09b951c86c1bf1116af741fa4664511f2f179f0a/like_button.js), Babel will create a compiled `like_button.js` with the plain JavaScript code suitable for the browser. When you edit the JSX file, the transform will re-run automatically. + +As a bonus, this will also let you use modern JavaScript syntax features like classes without worrying about breaking older browsers. The tool we just used is called Babel, and you can learn more about it from [its documentation](http://babeljs.io/docs/en/babel-cli/). + +If you notice that you're getting comfortable with build tools and want them to do more for you, [the next section](/docs/create-a-new-react-app.html) describes some of the most popular and approachable toolchains. If not -- those script tags will do just fine! diff --git a/content/docs/add-react-to-an-existing-app.md b/content/docs/add-react-to-an-existing-app.md deleted file mode 100644 index 6381b38e..00000000 --- a/content/docs/add-react-to-an-existing-app.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -id: add-react-to-an-existing-app -title: Add React to an Existing Application -permalink: docs/add-react-to-an-existing-app.html -prev: add-react-to-a-new-app.html -next: cdn-links.html ---- - -You don't need to rewrite your app to start using React. - -We recommend adding React to a small part of your application, such as an individual widget, so you can see if it works well for your use case. - -While React [can be used](/docs/react-without-es6.html) without a build pipeline, we recommend setting it up so you can be more productive. A modern build pipeline typically consists of: - -* A **package manager**, such as [Yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/). It lets you take advantage of a vast ecosystem of third-party packages, and easily install or update them. -* A **bundler**, such as [webpack](https://webpack.js.org/) or [Browserify](http://browserify.org/). It lets you write modular code and bundle it together into small packages to optimize load time. -* A **compiler** such as [Babel](http://babeljs.io/). It lets you write modern JavaScript code that still works in older browsers. - -### Installing React - ->**Note:** -> ->Once installed, we strongly recommend setting up a [production build process](/docs/optimizing-performance.html#use-the-production-build) to ensure you're using the fast version of React in production. - -We recommend using [Yarn](https://yarnpkg.com/) or [npm](https://www.npmjs.com/) for managing front-end dependencies. If you're new to package managers, the [Yarn documentation](https://yarnpkg.com/en/docs/getting-started) is a good place to get started. - -To install React with Yarn, run: - -```bash -yarn init -yarn add react react-dom -``` - -To install React with npm, run: - -```bash -npm init -npm install --save react react-dom -``` - -Both Yarn and npm download packages from the [npm registry](http://npmjs.com/). - -> Note: -> -> To prevent potential incompatibilities, all react packages should use the same version. (This includes `react`, `react-dom`, `react-test-renderer`, etc.) - -### Enabling ES6 and JSX - -We recommend using React with [Babel](http://babeljs.io/) to let you use ES6 and JSX in your JavaScript code. ES6 is a set of modern JavaScript features that make development easier, and JSX is an extension to the JavaScript language that works nicely with React. - -The [Babel setup instructions](https://babeljs.io/docs/setup/) explain how to configure Babel in many different build environments. Make sure you install [`babel-preset-react`](http://babeljs.io/docs/plugins/preset-react/#basic-setup-with-the-cli-) and [`babel-preset-env`](http://babeljs.io/docs/plugins/preset-env/) and enable them in your [`.babelrc` configuration](http://babeljs.io/docs/usage/babelrc/), and you're good to go. - -### Hello World with ES6 and JSX - -We recommend using a bundler like [webpack](https://webpack.js.org/) or [Browserify](http://browserify.org/), so you can write modular code and bundle it together into small packages to optimize load time. - -The smallest React example looks like this: - -```js -import React from 'react'; -import ReactDOM from 'react-dom'; - -ReactDOM.render( -

Hello, world!

, - document.getElementById('root') -); -``` - -This code renders into a DOM element with the id of `root`, so you need `
` somewhere in your HTML file. - -Similarly, you can render a React component inside a DOM element somewhere inside your existing app written with any other JavaScript UI library. - -[Learn more about integrating React with existing code.](/docs/integrating-with-other-libraries.html#integrating-with-other-view-libraries) - -### A Complete Example - -You can find step-by-step instructions detailing a basic implementation from scratch, including Babel and Webpack setup [here](https://medium.com/@JedaiSaboteur/creating-a-react-app-from-scratch-f3c693b84658). - -### Development and Production Versions - -By default, React includes many helpful warnings. These warnings are very useful in development. - -**However, they make the development version of React larger and slower so you should use the production version when you deploy the app.** - -Learn [how to tell if your website is serving the right version of React](/docs/optimizing-performance.html#use-the-production-build), and how to configure the production build process most efficiently: - -* [Creating a Production Build with Create React App](/docs/optimizing-performance.html#create-react-app) -* [Creating a Production Build with Single-File Builds](/docs/optimizing-performance.html#single-file-builds) -* [Creating a Production Build with Brunch](/docs/optimizing-performance.html#brunch) -* [Creating a Production Build with Browserify](/docs/optimizing-performance.html#browserify) -* [Creating a Production Build with Rollup](/docs/optimizing-performance.html#rollup) -* [Creating a Production Build with webpack](/docs/optimizing-performance.html#webpack) - -### Using a CDN - -If you don't want to use npm to manage client packages, the `react` and `react-dom` npm packages also provide single-file distributions in `umd` folders. See the [CDN](/docs/cdn-links.html) page for links. diff --git a/content/docs/cdn-links.md b/content/docs/cdn-links.md index 9205e721..9f48a01f 100644 --- a/content/docs/cdn-links.md +++ b/content/docs/cdn-links.md @@ -2,11 +2,11 @@ id: cdn-links title: CDN Links permalink: docs/cdn-links.html -prev: add-react-to-an-existing-app.html +prev: create-a-new-react-app.html next: hello-world.html --- -The UMD builds of React and ReactDOM are available over a CDN. +Both React and ReactDOM are available over a CDN. ```html diff --git a/content/docs/create-a-new-react-app.md b/content/docs/create-a-new-react-app.md new file mode 100644 index 00000000..48e7a4e2 --- /dev/null +++ b/content/docs/create-a-new-react-app.md @@ -0,0 +1,93 @@ +--- +id: create-a-new-react-app +title: Create a New React App +permalink: docs/create-a-new-react-app.html +redirect_from: "docs/add-react-to-a-new-app.html" +prev: add-react-to-a-website.html +next: cdn-links.html +--- + +Use an integrated toolchain for the best user and developer experience. + +This page describes a few popular React toolchains which help with tasks like: + +* Scaling to many files and components. +* Using third-party libraries from npm. +* Detecting common mistakes early. +* Live-editing CSS and JS in development. +* Optimizing the output for production. + +The toolchains recommended on this page **don't require configuration to get started**. + +## HTML with `