Skip to content

docs: add Getting Started guide and update prerequisites for CircuiVerse (desktop tauri setup) #598

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add Getting Started guide and update prerequisites for CircuiVerse (desktop tauri setup) #598

wants to merge 3 commits into from

Conversation

blazethunderstorm
Copy link

Fixes #509

Describe the changes you have made in this PR -

Added Tauri prerequisites, Rust installation steps, and npm run tauri dev/build commands to README.

Screenshots of the changes (If any) -

Note: Please check Allow edits from maintainers. if you would like us to assist in the PR.

@blazethunderstorm
Copy link
Author

@Arnabdaz @ThatDeparted2061 @niladrix719 i have made required changes and have made the readme and getting started both seprately , pls review the changes , Thanks

@netlify Netlify
Copy link

netlify bot commented Jun 12, 2025 •
edited
Loading

✅ Deploy Preview for circuitverse ready!

Name Link
🔨 Latest commit 1ff3dcf
🔍 Latest deploy log https://app.netlify.com/projects/circuitverse/deploys/685c7e492c26530008f8a8b1
😎 Deploy Preview https://deploy-preview-598--circuitverse.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 46 (🔴 down 1 from production)
Accessibility: 72 (no change from production)
Best Practices: 92 (no change from production)
SEO: 80 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@ThatDeparted2061
Copy link
Member

Attach link for the getting started from you fork

@blazethunderstorm blazethunderstorm changed the title docs: add Getting Started guide and update prerequisites for CircuitV… docs: add Getting Started guide and update prerequisites for CircuiVerse Jun 18, 2025
@blazethunderstorm blazethunderstorm changed the title docs: add Getting Started guide and update prerequisites for CircuiVerse docs: add Getting Started guide and update prerequisites for CircuiVerse (desktop tauri setup) Jun 18, 2025
@blazethunderstorm
Copy link
Author

@ThatDeparted2061 would make the req changes

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 25, 2025 •
edited
Loading

Warning

Rate limit exceeded

@blazethunderstorm has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 17 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 8d8ca00 and 1ff3dcf.

📒 Files selected for processing (2)
  • GETTING_STARTED.md (1 hunks)
  • README.md (2 hunks)

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

@blazethunderstorm
Copy link
Author

@ThatDeparted2061 i have made the asked changes pls review

ThatDeparted2061
ThatDeparted2061 suggested changes Jul 1, 2025
View reviewed changes
GETTING_STARTED.md
```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2. Follow the installation prompts
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are no statements below this intentional? if not then remove this point (kinda mundane)

README.md
```
## Development

To get started, please refer to [`GETTING_STARTED.md`](https://github.com/blazethunderstorm/cv-frontend-vue/blob/docc/GETTING_STARTED.md) for full setup instructions.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can't give link to your docs, change the link to what wud be the link when PR gets merged

@blazethunderstorm
Copy link
Author

@ThatDeparted2061 alright

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ThatDeparted2061 ThatDeparted2061 ThatDeparted2061 requested changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Add Documentation for Desktop application Development
2 participants
@blazethunderstorm @ThatDeparted2061