Skip to content

Commit e43b18a

Browse files
author
Your Name
committed
fix complete
1 parent 79db06c commit e43b18a

File tree

1 file changed

+28
-53
lines changed

1 file changed

+28
-53
lines changed

README.md

Lines changed: 28 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -97,46 +97,40 @@ Make sure you have `pnpm` installed globally before proceeding.
9797

9898
```bash
9999
pnpm install
100+
```
100101

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:
102103

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**
107105

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:
110108

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+
```
115112

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.
118-
`https://classic.yarnpkg.com/en/docs/install#windows-stable`
119113

114+
**Or Download Package**
115+
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.
116+
[https://pnpm.io/installation](https://pnpm.io/installation)
120117

121-
> **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+
```
122123

123-
```
124-
npm install --legacy-peer-deps
125-
```
126124

127125

128126
### 🦄 Start the Development Mode
129127

130128
Use the following command to start the app in the development mode:
131129

132130
```bash
133-
yarn start
131+
pnpm start
134132
```
135-
or if you installed dependencies using ``npm`` use below command
136133

137-
```
138-
npm start
139-
```
140134

141135
**Note**: The `start` script automatically invokes "linters" process. Should you need to run the app without `lint` the use `start:nolint` instead.
142136
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:
152146
#### Format the code
153147

154148
```bash
155-
yarn run format
156-
```
157-
OR
158-
```
159-
npm run format
149+
pnpm run format
160150
```
161151

152+
162153
#### Lint the code
163154
*to check the linting issue*
164155
```bash
165-
yarn run lint
166-
```
167-
OR
168-
```
169-
npm run lint
156+
pnpm run lint
170157
```
158+
171159
*to fix the linting issue*
172160
```bash
173-
yarn run lint:fix
174-
```
175-
OR
176-
```
177-
npm run lint:fix
161+
pnpm run lint:fix
178162
```
179163

164+
180165
### 🧱 Build the App for Production
181166

182167
Use the following command to build the app for production:
183168

184169
```bash
185-
yarn build
186-
```
187-
OR
188-
```
189-
npm build
170+
pnpm build
190171
```
191172

173+
192174
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.
193175

194176
--------------------------------------------------------------
@@ -197,22 +179,15 @@ It builds the app for production to the `build` folder. It correctly bundles Rea
197179

198180
Use the following command to install browser(s) binaries to test locally:
199181
```bash
200-
yarn install playwright
201-
```
202-
OR
203-
```
204-
npm install playwright
182+
pnpm install playwright
205183
```
206184

207185
Use the following command to run Playwright tests:
208186

209187
```bash
210-
yarn e2e
211-
```
212-
OR
213-
```
214-
npm run e2e
188+
pnpm run e2e
215189
```
190+
216191
👀 Read more about testing in [react-play](../react-play/e2e/README.md)
217192

218193
👀 Read more about playwright: https://playwright.dev/

0 commit comments

Comments
 (0)