You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dotcom-rendering/README.md
+14-8Lines changed: 14 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,9 +30,17 @@ $ cd dotcom-rendering
30
30
31
31
### Install Node.js
32
32
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).
34
34
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).
36
44
37
45
For `fnm` this will be:
38
46
@@ -94,22 +102,20 @@ $ make install
94
102
95
103
If you get an Node version error then check the setup for your version manager.
96
104
97
-
### Running locally
105
+
### Run
98
106
99
107
```sh
100
108
$ make dev
101
109
```
102
110
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)
104
112
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.
106
114
107
115
You can render a specific article by appending the production URL to the `Article` endpoint, for example:
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:
0 commit comments