Skip to content

Commit e2ec375

Browse files
authored
CUMULUS-3862 - Updated documentation to account for short term React upgrade version dependency issues that arise using npm during install. (#1165)
* CUMULUS-3862 - updated install instructions * Updated the beginners file as well * Just one more line removal
1 parent a40b7b3 commit e2ec375

File tree

3 files changed

+4
-15
lines changed

3 files changed

+4
-15
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ This version of the dashboard requires Cumulus API >= v19.2.0-alpha.1 (TBD API r
1111

1212
### Changed
1313

14+
- **CUMULUS-3862**
15+
- Updated documentation to account for short term React upgrade version dependency issues that arise using npm.
16+
1417
- **GitHub Issue 1162**
1518
- Added documentation for beginners starting from scratch.
1619

CONTRIBUTING.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,6 @@ nvm use
7474
5. Install the cumulus dashboard
7575
For your first install,
7676
```bash
77-
npm ci
78-
```
79-
For subsequent runs,
80-
```bash
81-
npm install
82-
```
83-
Then run,
84-
```bash
8577
npm install [email protected] --legacy-peer-deps
8678
```
8779
6. Run the unit tests for cumulus dashboard. Do not proceed to the subsequent steps until all these tests have passed.

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -102,21 +102,15 @@ The dashboard uses node v20.12.2. To build/run the dashboard on your local machi
102102
#### install requirements
103103
We use npm for local package management. To install the requirements:
104104
```bash
105-
nvm use
106-
npm ci
105+
nvm use
107106
```
108107

109108
When package.json is updated.
110109

111-
```bash
112-
npm install
113-
```
114-
115110
```bash
116111
npm install [email protected] --legacy-peer-deps
117112
```
118113

119-
120114
To build a dashboard bundle<sup>[1](#bundlefootnote)</sup>:
121115

122116
```bash

0 commit comments

Comments
 (0)