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: update readme with instructions to use predeployed setup #647

Merged
merged 2 commits into from
Jan 30, 2025

Conversation

snigdha920
Copy link
Contributor

@snigdha920 snigdha920 commented Jan 30, 2025

Summary by Sourcery

Documentation:

  • Revised the README to guide users through the predeployed setup, making it the primary method for getting started. Added a separate section for customized deployments, outlining prerequisites and steps for deploying contracts and subgraphs.

Copy link

sourcery-ai bot commented Jan 30, 2025

Reviewer's Guide by Sourcery

This pull request updates the README.md file to include instructions for using a predeployed setup, which is the fastest way to get started with the starterkit. It also includes instructions for a customized setup where users can deploy their own contracts, subgraph, and ABIs.

Flow diagram: Setup options decision tree

flowchart TD
    Start[Start] --> Decision{Choose Setup Type}
    Decision -->|Fastest| Predeployed[Predeployed Setup]
    Decision -->|Customizable| Custom[Customized Setup]

    Predeployed --> P1[Install Dependencies]
    P1 --> P2[Login & Connect]
    P2 --> P3[Generate Types]
    P3 --> P4[Start Development]

    Custom --> C1[Install Dependencies]
    C1 --> C2[Login & Connect]
    C2 --> C3[Deploy Contracts]
    C3 --> C4[Deploy Subgraph]
    C4 --> C5[Setup Dapp]
    C5 --> C6[Start Development]
Loading

File-Level Changes

Change Details Files
Added instructions for using a predeployed setup.
  • Added a 'Predeployed Setup' section.
  • Added commands to install dependencies, login, connect to SettleMint, generate types, and start the development server.
  • Added a note to browse to http://localhost:3000 to access the application.
README.md
Updated instructions for a customized setup.
  • Added a 'Customized Setup' section.
  • Added prerequisites for Forge and Node.js.
  • Added commands to install dependencies, login, connect to SettleMint, deploy contracts, deploy subgraph, setup dapp, and start the development server.
  • Added a note to browse to http://localhost:3000 to access the application.
  • Added a note about replacing the chain ID with the actual chain ID.
README.md
Added a 'Known Limitations & TODOs' section.
  • Added a section for known limitations and TODOs.
  • Added a note about no CLI command to update ABIs automatically.
  • Added a note about admin account creation relying on first-signup mechanism.
  • Added a note about requiring settlemint connect twice.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@github-actions github-actions bot added the fix label Jan 30, 2025
@snigdha920 snigdha920 marked this pull request as ready for review January 30, 2025 08:20
@snigdha920 snigdha920 requested a review from SilVdB January 30, 2025 08:20
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @snigdha920 - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Review instructions: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@roderik roderik merged commit 26f8f05 into main Jan 30, 2025
3 checks passed
@roderik roderik deleted the fix/readme branch January 30, 2025 18:22
snigdha920 added a commit that referenced this pull request Jan 30, 2025
…board-queries

* main:
  feat: asset detail pages (#651)
  feat: cap bonds + remove duplicated validation (#649)
  fix: update readme with instructions to use predeployed setup (#647)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants