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

Refine Getting Started Instructions #42

Open
3 of 7 tasks
lightwalker-eth opened this issue Jan 21, 2025 · 0 comments
Open
3 of 7 tasks

Refine Getting Started Instructions #42

lightwalker-eth opened this issue Jan 21, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@lightwalker-eth
Copy link
Member

lightwalker-eth commented Jan 21, 2025

Creating this issue to help accelerate the closure of #20

  • Add Postgres to the list of prerequisites.
    • Note that Ponder requires Postgres >= 14.
    • Please see the separate discussion thread below regarding how we handle the database question.
  • Extend the getting started narrative to include steps for actually getting value out of the indexer. For example, something in the general direction of the following: https://ponder.sh/docs/getting-started/new-project#query-the-graphql-api
    • How to query the GraphQL API (what route to send requests to, relative to the hostname of the reader's indexer) / any other relevant details on this. Perhaps also link related documentation in Ponder docs.
    • Note that the GraphQL API of our indexer mimics the ENS Subgraph interface to make transitioning from the ENS Subgraph easy.
    • Instructions for how to configure ensjs to make use of our indexer. Please see points 2 and 3 shared in this Slack message: https://namehash.slack.com/archives/C086Z6FNBHN/p1735335513211229

Please consider and suggest other ideas / steps we should consider documenting to help others quickly and successfully get started running their own ENSNode instance.

@lightwalker-eth lightwalker-eth added this to the v1 milestone Jan 21, 2025
@lightwalker-eth lightwalker-eth added the documentation Improvements or additions to documentation label Jan 21, 2025
@lightwalker-eth lightwalker-eth moved this to Backlog in ENSNode Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Backlog
Development

No branches or pull requests

2 participants