Skip to content

Commit 6e207a4

Browse files
authored
Merge pull request #789 from complexdatacollective/update-README.md
Update README.md
2 parents ef490d1 + e8d1887 commit 6e207a4

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,21 @@ Jest (Testing suite)
1212
React Scripts
1313

1414
# Operation
15+
16+
## Node/NPM Version
17+
18+
This project currently requires version `12.14.1` of node, and version `6.13.4` of npm. These are the only supported versions for this project.
19+
20+
As a convenience, the repository contains a `.node-version` file that enables convinient use of a node environment manager.
21+
1522
## Installation
1623
This repository assumes that `npm` is installed. If you don't have it installed, here are [installation instructions](https://docs.npmjs.com/getting-started/installing-node).
1724

18-
1. Clone this repo.
19-
2. Go into the repo directory
20-
3. Initialise the submodules `npm run update-submodules`
25+
0. Install the correct node and npm versions
26+
1. Clone this repository.
27+
2. Fetch submodules by typing `git submodule update --init --recursive -f`.
28+
3. Enter the directory where the repository is cloned, and install the project dependencies by typing `npm install`.
29+
4. Refer to the development tasks section below to learn how to test and build the app.
2130

2231
### Available commands:
2332

0 commit comments

Comments
 (0)