Skip to content

Commit 3fbb586

Browse files
authored
Merge pull request #14302 from guardian/ravi/readme-minor-updates
README minor clarifications
2 parents cc88352 + 60a9aef commit 3fbb586

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

dotcom-rendering/README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,17 @@ $ cd dotcom-rendering
3030

3131
### Install Node.js
3232

33-
To install and manage Node versions, we highly recommend installing a Node version manager such as [fnm](https://github.com/Schniz/fnm) (preferred), [nvm](https://github.com/nvm-sh/nvm) or [asdf](https://asdf-vm.com/guide/getting-started.html).
33+
We highly recommend installing a Node version manager such as [fnm](https://github.com/Schniz/fnm) (preferred), [nvm](https://github.com/nvm-sh/nvm) or [asdf](https://asdf-vm.com/guide/getting-started.html).
3434

35-
Ensure you're at the root directory of this project, then follow the instructions for your version manager to install Node.
35+
Install the Node version manager of your choice.
36+
37+
Ensure you're at the root directory of the project:
38+
39+
```
40+
cd ~/code/dotcom-rendering
41+
```
42+
43+
Run the command for your version manager to use the Node version as specified in [.nvmrc](../.nvmrc).
3644

3745
For `fnm` this will be:
3846

@@ -94,22 +102,20 @@ $ make install
94102

95103
If you get an Node version error then check the setup for your version manager.
96104

97-
### Running locally
105+
### Run
98106

99107
```sh
100108
$ make dev
101109
```
102110

103-
The development server will start on [http://localhost:3030](http://localhost:3030).
111+
The development server will start on [http://localhost:3030](http://localhost:3030)
104112

105-
A list of content types with example URLs are available on the [root path](http://localhost:3030).
113+
The development server home page lists examples of the various page and content types.
106114

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

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-
118+
You can view the JSON data model of a page as sent by [Frontend](https://github.com/guardian/frontend) to DCR by appending `.json?dcr=true` to the production URL, for example:
113119
https://www.theguardian.com/sport/2019/jul/28/tour-de-france-key-moments-egan-bernal-yellow-jersey.json?dcr=true
114120

115121
### Detailed setup

0 commit comments

Comments
 (0)