diff --git a/README.md b/README.md index 59387caf2..0d6ca7ae3 100644 --- a/README.md +++ b/README.md @@ -92,42 +92,35 @@ Please change the directory after cloning the repository using the `cd **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. -> **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 +```bash +pnpm install --legacy-peer-deps + ``` -``` -npm install --legacy-peer-deps -``` ### 🦄 Start the Development Mode @@ -135,13 +128,9 @@ npm install --legacy-peer-deps Use the following command to start the app in the development mode: ```bash -yarn start +pnpm start ``` -or if you installed dependencies using ``npm`` use below command -``` -npm start -``` **Note**: The `start` script automatically invokes "linters" process. Should you need to run the app without `lint` the use `start:nolint` instead. However make sure that you run `start` script at least once before committing your code. Code with linter error may not be reviewed. @@ -157,43 +146,31 @@ Use the following command to format and lint the code: #### Format the code ```bash -yarn run format -``` -OR -``` -npm run format +pnpm run format ``` + #### Lint the code *to check the linting issue* ```bash -yarn run lint -``` -OR -``` -npm run lint +pnpm run lint ``` + *to fix the linting issue* ```bash -yarn run lint:fix -``` -OR -``` -npm run lint:fix +pnpm run lint:fix ``` + ### 🧱 Build the App for Production Use the following command to build the app for production: ```bash -yarn build -``` -OR -``` -npm build +pnpm build ``` + 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. -------------------------------------------------------------- @@ -202,22 +179,15 @@ It builds the app for production to the `build` folder. It correctly bundles Rea Use the following command to install browser(s) binaries to test locally: ```bash -yarn install playwright -``` -OR -``` -npm install playwright +pnpm install playwright ``` Use the following command to run Playwright tests: ```bash -yarn e2e -``` -OR -``` -npm run e2e +pnpm run e2e ``` + 👀 Read more about testing in [react-play](../react-play/e2e/README.md) 👀 Read more about playwright: https://playwright.dev/