From 7c71b1fe612fe50e8f95a92240f04a45786a082c Mon Sep 17 00:00:00 2001 From: vaibhavpnimkar <128807866+vaibhavpnimkar@users.noreply.github.com> Date: Sun, 8 Oct 2023 01:14:01 +0530 Subject: [PATCH] larified that these steps are intended for users facing installation errors. --- CONTRIBUTING.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cfb45b4..a5d1aee 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,6 +88,40 @@ To set up the development environment locally, follow these steps: ```bash yarn ``` + ### Troubleshooting Yarn Installation(For Users Encountering Errors) + +If you encounter an error related to Yarn installation, follow these steps to resolve it: + +1. **Ensure Your Project is Marked as Private**: Open the `package.json` file in the root directory of your project and add the `"private": true` property if it's not already present: + + ```json + "private": true + ``` + + This step is necessary to enable Yarn workspaces. + +2. **Update the `workspaces` Field**: In your `package.json` file, make sure the `"workspaces"` field is correctly configured to specify the directories that should be treated as workspace packages. For example: + + ```json + "workspaces": [ + "packages/*" + ] + ``` + + Adjust the pattern to match the directory structure of your project where your workspace packages are located. + +3. **Reinstall Dependencies**: After making these changes, run the following command to reinstall project dependencies: + + ```bash + yarn install + ``` + + This will ensure that Yarn sets up the workspace correctly. + + + +By following these steps, you can resolve any issues related to Yarn workspaces and continue with the setup process. + 4. Copy the `.env.example` file to `.env.local` and configure the following environment variables in the `.env.local` file: