Skip to content

Commit a7424af

Browse files
committed
Small tweaks to README
1 parent e7bf111 commit a7424af

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

dotcom-rendering/README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ It primarily uses [TypeScript](https://www.typescriptlang.org/), [Node.js](https
88

99
This guide will help you get the `dotcom-rendering` application running on your development machine.
1010

11+
### Clone the repository
12+
1113
Start in your `~/code` directory:
1214

1315
```
@@ -66,9 +68,9 @@ This configuration allows the Node version detection to scan all parent director
6668

6769
https://github.com/Schniz/fnm/blob/master/docs/configuration.md#--version-file-strategyrecursive
6870

69-
### Corepack
71+
### Enable corepack
7072

71-
Enable [corepack](https://github.com/nodejs/corepack) to install the correct package manager:
73+
Enable [corepack](https://github.com/nodejs/corepack) to install the correct package manager and version:
7274

7375
```sh
7476
$ corepack enable
@@ -98,14 +100,16 @@ If you get an Node version error then check the setup for your version manager.
98100
$ make dev
99101
```
100102

101-
Will start the development server on [http://localhost:3030](http://localhost:3030).
103+
The development server will start on [http://localhost:3030](http://localhost:3030).
104+
105+
A list of content types with example URLs are available on the [root path](http://localhost:3030).
102106

103-
A list of content types with example URLs is available on the [root path](http://localhost:3030).
107+
You can render a specific article by appending the production URL to the `Article` endpoint, for example:
104108

105-
You can render a specific article by appending the the production URL to the `Article` endpoint, for example:
106109
http://localhost:3030/Article/https://www.theguardian.com/sport/2019/jul/28/tour-de-france-key-moments-egan-bernal-yellow-jersey
107110

108-
You can view the JSON representation of an article as sent by [Frontend](https://github.com/guardian/frontend) to DCR, by appending `.json?dcr=true` to the production URL, for example:
111+
You can view the JSON representation of an article as sent to DCR by [Frontend](https://github.com/guardian/frontend), by appending `.json?dcr=true` to the production URL, for example:
112+
109113
https://www.theguardian.com/sport/2019/jul/28/tour-de-france-key-moments-egan-bernal-yellow-jersey.json?dcr=true
110114

111115
### Detailed setup
@@ -157,7 +161,7 @@ We recommend you update your workspace settings to automatically fix formatting
157161
| <img alt="Preact" src="./docs/images/logo-preact.jpg" width="350" /> | DCR is rendered on the server with Preact and uses Preact as the Client-side framework. We use preact-compat to ensure compatability with React modules. |
158162
| <img alt="Emotion CSS-in-JS" src="./docs/images/logo-emotion.png" width="350" /> | [Emotion](https://emotion.sh) is css-in-js library, DCR uses the `css` tagged template literal style to allow CSS copy-pasting. |
159163
| <img alt="Express" src="./docs/images/logo-express.png" width="350" /> | We use [Express](https://expressjs.com/) as a very thin server to communicate with the Frontend endpoint. |
160-
| <img alt="Webpack" src="./docs/images/logo-webpack.png" width="350" /> | [Webpack](https://webpack.js.org/) is used for its dev server and as a bundler our production code. |
164+
| <img alt="Webpack" src="./docs/images/logo-webpack.png" width="350" /> | [Webpack](https://webpack.js.org/) is used for its dev server and as a bundler for our production code. |
161165
| <img alt="SWC" src="./docs/images/logo-swc.png" width="350" /> | [SWC](https://swc.rs/) is used as a Webpack loader that allows for very fast compilation. |
162166
| <img alt="Storybook" src="./docs/images/logo-storybook.jpg" width="350" /> | We use [Storybook](https://storybook.js.org/) to generate [component variations](https://main--63e251470cfbe61776b0ef19.chromatic.com) that are then visual regression tested in [Chromatic](https://www.chromatic.com/). You'll notice `.stories.` files in the repository that define the component variations. |
163167
| <img alt="Chromatic" src="./docs/images/logo-chromatic.jpg" width="350" /> | [Chromatic](https://www.chromatic.com/) is a visual regression testing tool that tests our Storybook components at PR time. |

0 commit comments

Comments
 (0)