Skip to content

Commit a2b62cd

Browse files
authored
fix: update peer deps for npm install (#905)
- Fix `npm install` error (peer dependencies issue) - Update README.md - prioritize yarn - Update README.md - OS dependency-related caveats from Getting started to under Build
1 parent ecb4a23 commit a2b62cd

File tree

3 files changed

+2938
-4071
lines changed

3 files changed

+2938
-4071
lines changed

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ We are introducing a new version of the Sendbird Chat UIKit. Version 3 features
99

1010
## Installation
1111

12-
`npm i @sendbird/uikit-react`
13-
or if you're using yarn
1412
`yarn add @sendbird/uikit-react`
13+
or if you're using npm
14+
`npm i @sendbird/uikit-react`
1515

1616
## Getting Started
1717

@@ -39,26 +39,24 @@ And many more...
3939

4040
You need to install:
4141
* nodejs 16 LTS https://nodejs.org/en/download/
42-
* npm 8 >= or yarn
43-
44-
**Caveats**
45-
- We tried development on Mac OS / Linux systems. You might encounter problems in running `npm run build` or `yarn run build` in Windows machines
42+
* npm 8>= or yarn 3>=
4643

4744
### Development
45+
4846
We use storybook for development and rollup for building the npm distribution(bundled JS file)
49-
Make sure you have nodejs and npm (or yarn) installed and run
47+
Make sure you have nodejs and yarn(or npm) installed and run
5048

5149
> Make a copy of .env.example and save it as .env
52-
> Set your appId STORYBOOK_APP_ID
50+
> Set your appId `STORYBOOK_APP_ID`
5351
5452
```
55-
npm install
56-
npm run storybook
53+
yarn install
54+
yarn storybook
5755
```
5856
or
5957
```
60-
yarn install
61-
yarn storybook
58+
npm install
59+
npm run storybook
6260
```
6361

6462
* By default, storybook opens in http://localhost:6006/
@@ -82,42 +80,46 @@ To enable Husky in local, run:
8280

8381
### Build
8482

85-
We use rollupJS for building the production bundle script that you want to use inside your applications.
83+
We use RollupJS for building the production bundle script that you want to use inside your applications.
8684

87-
We have both esm and commonjs output
85+
We have both `ESM` and `CJS` output
8886

8987
```
90-
npm run build
88+
yarn build
9189
```
9290
or
9391
```
94-
yarn run build
92+
npm run build
9593
```
9694

97-
The bundled JS code can be found in `./release`
98-
The CSS is in `./release/dist/index.css`
95+
The bundled JS code can be found in `./dist`
96+
The CSS is in `./dist/dist/index.css`
97+
98+
**Caveats**
99+
- We tried development on Mac OS / Linux systems. You might encounter problems in running `yarn build` or `npm run build` in Windows machines
99100

100101
## Running the tests
101102

102103
We have implemented tests for dumb ui components only. Technologies used: Jest and testing-library
103104

104105
```
105-
npm run test
106+
yarn test
106107
```
107108
or
108109
```
109-
yarn run test
110+
npm run test
110111
```
111112

112113
### Lint
113114

114115
```
115-
npm run lint
116+
yarn lint
116117
```
117118
or
118119
```
119-
yarn run lint
120+
npm run lint
120121
```
122+
121123
* .eslintrc.json lints ts files and .eslintrc.js lints js files
122124

123125
### Webpack 5

package.json

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@
8282
"@babel/eslint-parser": "^7.22.15",
8383
"@babel/plugin-proposal-class-properties": "^7.18.6",
8484
"@babel/plugin-proposal-export-default-from": "^7.22.17",
85+
"@babel/plugin-proposal-private-property-in-object": "^7.21.11",
8586
"@babel/preset-env": "^7.23.2",
8687
"@babel/preset-react": "^7.22.15",
8788
"@babel/preset-typescript": "^7.23.2",
@@ -103,8 +104,8 @@
103104
"@testing-library/jest-dom": "^5.16.5",
104105
"@testing-library/react": "^13.4.0",
105106
"@testing-library/user-event": "^14.4.3",
106-
"@typescript-eslint/eslint-plugin": "^5.59.2",
107-
"@typescript-eslint/parser": "^5.59.2",
107+
"@typescript-eslint/eslint-plugin": "^6.17.0",
108+
"@typescript-eslint/parser": "^6.17.0",
108109
"autoprefixer": "^9.7.4",
109110
"babel-jest": "^29.0.1",
110111
"babel-loader": "^8.0.6",
@@ -131,10 +132,10 @@
131132
"postcss": "^8.3.5",
132133
"react": "^18.2.0",
133134
"react-dom": "^18.2.0",
134-
"rollup": "^4.1.4",
135+
"rollup": "^4.9.2",
135136
"rollup-plugin-analyzer": "^4.0.0",
136137
"rollup-plugin-copy": "^3.5.0",
137-
"rollup-plugin-polyfill-node": "^0.12.0",
138+
"rollup-plugin-polyfill-node": "^0.13.0",
138139
"rollup-plugin-postcss": "^4.0.2",
139140
"rollup-plugin-scss": "^4.0.0",
140141
"rollup-plugin-typescript2": "^0.36.0",

0 commit comments

Comments
 (0)