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: README.md
+28-53Lines changed: 28 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,46 +97,40 @@ Make sure you have `pnpm` installed globally before proceeding.
97
97
98
98
```bash
99
99
pnpm install
100
+
```
100
101
101
-
if you don't have `yarn` installed on your PC, follow the steps below to install it..
102
+
If you don't have `pnpm` installed on your PC, follow the steps below to install it:
102
103
103
-
**Windows**
104
-
1. open your command prompt as administrator.
105
-
2. write `corepack enable` and hit enter.
106
-
3. then `npm install --global yarn`
104
+
**Windows / Linux / macOS**
107
105
108
-
**Linux**
109
-
1. open terminal and hit `npm install --global yarn`
106
+
1. Open your terminal or command prompt.
107
+
2. Run the following command to install `pnpm` globally:
110
108
111
-
**MacOS**
112
-
1. open terminal and hit `npm install --global yarn`
113
-
or
114
-
`brew install yarn`
109
+
```bash
110
+
npm install -g pnpm
111
+
```
115
112
116
-
**Or Download Package**
117
-
If you are unable to install yarn following the above-mentioned process, then you can simply download the package and install it. Visit the official website of Yarn; there you can just expand the "Alternative" section and it will ask for the version to download for Windows, Linux, or Mac.
If you are unable to install `pnpm` following the above-mentioned process, you can simply download the package and install it. Visit the official website of `pnpm`; there you can find instructions for Windows, Linux, or macOS.
> **Note**: `ReactPlay` runs on React 18. However, some of our dependencies are yet to upgrade to version 18. So please use the following command when you face difficulties installing the dependencies. Also, ensure to use Node.js version >= 16.x
118
+
> **Note**: `ReactPlay` runs on React 18. However, some of our dependencies are yet to upgrade to version 18. So please use the following command if you face difficulties installing the dependencies. Also, ensure you are using Node.js version >= 16.x.
119
+
120
+
```bash
121
+
pnpm install --legacy-peer-deps
122
+
```
122
123
123
-
```
124
-
npm install --legacy-peer-deps
125
-
```
126
124
127
125
128
126
### 🦄 Start the Development Mode
129
127
130
128
Use the following command to start the app in the development mode:
131
129
132
130
```bash
133
-
yarn start
131
+
pnpm start
134
132
```
135
-
or if you installed dependencies using ``npm`` use below command
136
133
137
-
```
138
-
npm start
139
-
```
140
134
141
135
**Note**: The `start` script automatically invokes "linters" process. Should you need to run the app without `lint` the use `start:nolint` instead.
142
136
However make sure that you run `start` script at least once before committing your code. Code with linter error may not be reviewed.
@@ -152,43 +146,31 @@ Use the following command to format and lint the code:
152
146
#### Format the code
153
147
154
148
```bash
155
-
yarn run format
156
-
```
157
-
OR
158
-
```
159
-
npm run format
149
+
pnpm run format
160
150
```
161
151
152
+
162
153
#### Lint the code
163
154
*to check the linting issue*
164
155
```bash
165
-
yarn run lint
166
-
```
167
-
OR
168
-
```
169
-
npm run lint
156
+
pnpm run lint
170
157
```
158
+
171
159
*to fix the linting issue*
172
160
```bash
173
-
yarn run lint:fix
174
-
```
175
-
OR
176
-
```
177
-
npm run lint:fix
161
+
pnpm run lint:fix
178
162
```
179
163
164
+
180
165
### 🧱 Build the App for Production
181
166
182
167
Use the following command to build the app for production:
183
168
184
169
```bash
185
-
yarn build
186
-
```
187
-
OR
188
-
```
189
-
npm build
170
+
pnpm build
190
171
```
191
172
173
+
192
174
It builds the app for production to the `build` folder. It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.
0 commit comments