Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Clarified that these steps are intended for users facing installation... #14

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading