@samitouri / QOS-React / commits / 9d3ceb6895

Update readme for DOM Fixtures

Nathan Hunzaker committed Jan 6, 2017 at 17:14 UTC 9d3ceb689547de937a5991c2c790fb671ab3aa00
1 file changed +10 -43
fixtures/dom/README.md
+10 -43
@@ -1,50 +1,17 @@
1 -# Manual Testing Fixtures
1 +# DOM Fixtures
2
3 -This folder exists for **React contributors** only.
4 -If you use React you don't need to worry about it.
3 +A set of DOM test cases for quickly identifying browser issues.
4
6 -These fixtures verify that the built React distributions are usable in different environments.
7 -**They are not running automatically.** (At least not yet, feel free to contribute to automate them.)
5 +## Setup
6
9 -Run them when you make changes to how we package React, ReactDOM, and addons.
10 -
11 -## How to Run
12 -
13 -First, build React and the fixtures:
14 -
15 -```
16 -cd react
17 -npm run build
18 -
19 -cd fixtures
20 -node build-all.js
21 -```
22 -
23 -Then run a local server at the root of the repo, e.g.
7 +To reference a local build of React, first run `npm run build` at the root
8 +of the React project. Then:
9
10 ```
26 -npm i -g pushstate-server
27 -cd ..
28 -pushstate-server .
11 +cd fixtures/dom
12 +npm install
13 +npm start
14 ```
15
31 -(Too complicated? Send a PR to simplify this :-).
32 -
33 -Then open the corresponding URLs, for example:
34 -
35 -```
36 -open http://localhost:9000/fixtures/globals.html
37 -open http://localhost:9000/fixtures/requirejs.html
38 -open http://localhost:9000/fixtures/systemjs.html
39 -open http://localhost:9000/fixtures/browserify/index.html
40 -open http://localhost:9000/fixtures/brunch/index.html
41 -open http://localhost:9000/fixtures/rjs/index.html
42 -open http://localhost:9000/fixtures/systemjs-builder/index.html
43 -open http://localhost:9000/fixtures/webpack/index.html
44 -open http://localhost:9000/fixtures/webpack-alias/index.html
45 -```
46 -
47 -You should see two things:
48 -
49 -* "Hello World" fading in with an animation.
50 -* No errors in the console.
16 +The `start` command runs a script that copies over the local build of react into
17 +the public directory.