Create end-to-end guide on fetching data from an indexer (Goldsky) and integrating it into a frontend interface

[briwylde08]

Recommended indexer: Goldsky

Guide could include:

• Introduction to indexers
• Explain what they are and what their role is in data management and retrieval
• Discuss the types of data indexers can provide
• Setting up data retrieval
• Outline the process for connecting with an indexer
• Provide step-by-step instructions on how to query or retrieve data from an indexer
• Frontend integration
• Discuss how to process and prepare the retrieved data for frontend use
• Guidance on displaying the data effectively in an application

SDF contact for help: @johncanneto

[raizo07]

Hello @briwylde08 I'll like to be assigned to work on this

[Benjtalkshow]

@briwylde08
I'd like to take on this task. I am familiar with using Goldsky and i am good technical write

[legend4tech]

Hi am legend4tech, a fullstack developer and Also an onlydust stellar Fellow, would love to take up this issue .

[briwylde08]

@legend4tech - got you assigned! Thank you!

[legend4tech]

Thanks ✅ on it . If any questions I would reach out

[legend4tech]

@johncanneto Hi, I was assigned this issue and I need some guidance.
First, could you clarify the folder path where I should implement the solution?
Also, should I be testing the implementation, and if so, what is the process for that?
Are there any other details I should know to implement this properly?

Currently, I’ve cloned the repo locally, have Docker Desktop and the dev container set up, and I’m installing the dependencies to get started. I just need your guidance on the points above to proceed correctly.

[briwylde08]

For one, you can put the guide in this folder path: https://developers.stellar.org/docs/build/guides/dapps

[ElliotFriend]

Hi, @legend4tech!

Thanks for jumping into this issue! Can't wait to see what you cook up! Here are some thoughts to help as you get started:

• As Bri pointed out above, that "Dapp Development" collection of "How-To Guides" is probably the most fitting place for this document. In this repository, you can find that directory here: /docs/build/guides/dapps. Create a new filename.mdx file in that directory, and you're off to the races.
• As far as "testing" goes, there's not so much "formal" tests for the code snippets you'll write. As long as the code "would work" if it were adapted into a real project, that's good by me.
• Some more details:
  • In an ideal world, the page you'll write will contain some explanatory content alongside code chunks/examples. It doesn't have to be a complete, full-fledged example, though. We're looking to highlight the specific "get data from an indexer" angle and how just that piece gets implemented.
  • If I were writing this, the approach I would probably take would be to
    1. Choose a Stellar project that's used frequently and emits events (since they're supported by goldsky). For example, here's a Blend transaction where a supply_collateral event is emitted
    2. Then, I'd walk through the steps for finding and/or making sure those events are available in goldsky
    3. Give some code examples for how my Javascript files could fetch that data from goldsky (even an example function called getEventsFromGoldsky() or something would work)
    4. Create a super-simple JS/React/Next/whatever code snippet that takes the fetched data and displays it into an HTML table or something.
    5. Add in some context and explainer content interspersed along the way.

Does that make sense? That's just an example, of course. You're free to create it however you like.

A note about the dev container setup. I'm not super familiar with dev containers and how that workflow works (that was created/setup in this repo by somebody else). But, if that's not a regular part of your own workflow, feel free to ignore it. You can just write a plaintext (MDX) file, commit the contents and make a PR.

Hope some of that helps. Please feel free to reach out if you've got any other questions or need help along the way.

[legend4tech]

Hi, @legend4tech!

Thanks for jumping into this issue! Can't wait to see what you cook up! Here are some thoughts to help as you get started:

• As Bri pointed out above, that "Dapp Development" collection of "How-To Guides" is probably the most fitting place for this document. In this repository, you can find that directory here: /docs/build/guides/dapps. Create a new filename.mdx file in that directory, and you're off to the races.

• As far as "testing" goes, there's not so much "formal" tests for the code snippets you'll write. As long as the code "would work" if it were adapted into a real project, that's good by me.

• Some more details:

  • In an ideal world, the page you'll write will contain some explanatory content alongside code chunks/examples. It doesn't have to be a complete, full-fledged example, though. We're looking to highlight the specific "get data from an indexer" angle and how just that piece gets implemented.

  • If I were writing this, the approach I would probably take would be to

    1. Choose a Stellar project that's used frequently and emits events (since they're supported by goldsky). For example, here's a Blend transaction where a supply_collateral event is emitted
    2. Then, I'd walk through the steps for finding and/or making sure those events are available in goldsky
    3. Give some code examples for how my Javascript files could fetch that data from goldsky (even an example function called getEventsFromGoldsky() or something would work)
    4. Create a super-simple JS/React/Next/whatever code snippet that takes the fetched data and displays it into an HTML table or something.
    5. Add in some context and explainer content interspersed along the way.

Does that make sense? That's just an example, of course. You're free to create it however you like.

A note about the dev container setup. I'm not super familiar with dev containers and how that workflow works (that was created/setup in this repo by somebody else). But, if that's not a regular part of your own workflow, feel free to ignore it. You can just write a plaintext (MDX) file, commit the contents and make a PR.

Hope some of that helps. Please feel free to reach out if you've got any other questions or need help along the way.

Alright 👌 Thanks for this would follow all the instructions and pull out the best.

As for the dev container, don't worry about that I have docker installed in my pc, and as of yesterday evening am already done with the installation of the dependencies and am currently running the docs locally at port 3000.
Thanks once more, will keep InTouch