Skip to content

Commit 957dd9f

Browse files
committed
update readme with set up instructions
1 parent 14a479a commit 957dd9f

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,39 @@ Consists of:
44

55
1. A Node.js server for serving marketing messages to theguardian.com ([dotcom-rendering](https://github.com/guardian/dotcom-rendering/)). See [server.md](./docs/server.md) for details
66
2. An npm package with types and logic for use by dotcom-rendering.
7+
8+
### Set Up
9+
10+
To get the server running on local, just perform the following operations
11+
12+
- Clone the repository
13+
14+
```
15+
$ git clone https://github.com/guardian/support-dotcom-components
16+
$ cd support-dotcom-components
17+
```
18+
19+
- Ensure that you are running the right version of node
20+
21+
```
22+
$ nvm install
23+
$ nvm use
24+
```
25+
26+
(`nvm install` is only required if you didn't already have the right version installed on your machine.)
27+
28+
- We are using pnpm as package manager. If you do not have it installed on your machine, please install it. Then
29+
30+
```
31+
pnpm install
32+
pnpm build-server
33+
pnpm prestart
34+
```
35+
36+
- At this point we are ready to run the server, for this grab **membership** Janus credentials for your terminal.
37+
38+
- Start the server
39+
40+
```
41+
pnpm start
42+
```

0 commit comments

Comments
 (0)