chore: local dev improvements

[aheckmann]

Description

A first attempt at lowering the barrier to contributions.

• Improve the local development getting started experience
• Uses a recent yarn version
• Deduplicates the local env setup docs
• Clarifies CONTRIBUTING
• Runs the web apps without docker

Type of Change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] Feature (non-breaking change which adds functionality)
• [ ] Improvement (change that would cause existing functionality to not work as expected)
• [x] Code refactoring
• [ ] Performance improvements
• [x] Documentation update

Screenshots and Media (if applicable)

Test Scenarios

Ran through the steps. Was able to register in god-mode, log into the web app, and create a project.

References

[CLAassistant]

All committers have signed the CLA.

[coderabbitai[bot]]

Walkthrough

This update introduces several configuration and documentation changes across the project. The .gitignore file now excludes the .yarn directory, and a .yarnrc.yml file is added to specify the use of the node-modules linker for Yarn. The package.json is updated to require Yarn 4.9.1, and the setup script now installs Corepack and runs yarn install. Multiple .env.example files are revised to include explicit localhost URLs for development. The docker-compose-local.yml file is modified to expose ports and comment out several services. Documentation in README.md and CONTRIBUTING.md is cleaned up and clarified, with setup instructions consolidated.

Changes

Files / Groups	Change Summary
.gitignore, .yarnrc.yml, package.json	Updated to ignore .yarn, specify Yarn node-modules linker, and require Yarn 4.9.1.
setup.sh	Adds Corepack installation and yarn install after generating Django SECRET_KEY.
admin/.env.example, space/.env.example, web/.env.example, live/.env.example	Updated environment examples to provide explicit localhost URLs for API and web services.
apiserver/.env.example	Expanded allowed CORS origins, added Sentry variables, and set default admin/app base URLs.
docker-compose-local.yml	Exposes ports for Redis, MinIO, PostgreSQL, API; comments out several services.
admin/package.json	Reordered @plane/services in dependencies list.
README.md	Removed detailed local setup instructions, referencing CONTRIBUTING.md instead; whitespace cleanup.
CONTRIBUTING.md	Expanded and clarified setup instructions, updated requirements, improved formatting.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant SetupScript
    participant Node
    participant Yarn
    Developer->>SetupScript: Run setup.sh
    SetupScript->>Node: Install Corepack globally
    SetupScript->>Yarn: Run yarn install
    Yarn-->>SetupScript: Install dependencies using node-modules linker
    SetupScript-->>Developer: Setup complete

Possibly related PRs

• makeplane/plane#6954: Both PRs update the CONTRIBUTING.md to improve and clarify contributor documentation and setup requirements.

Poem

Hopping through configs, a rabbit so spry,
Updates the docs and gives Yarn a try.
Localhost URLs now easy to find,
Setup is smoother, with changes aligned.
With ports exposed and Corepack in tow,
This project’s garden is ready to grow! 🥕

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.