/devportal-tutorials-js

Tutorials for the Developer Portal

Primary LanguageJavaScriptMIT LicenseMIT

devportal-tutorials-js

Javascript Tutorials for the Developer Portal

These examples/tutorials will familiarize you with the basics of operating on the steem blockchain.

Each tutorial is located in its own folder, and has a README.md with an outline of the basic concepts and operations it intends to teach. Some of the tutorials use the production blockchain, others use a testnet.

The tutorials build on each other. It's suggested you go through them in-order.

Tutorial List

  1. Blog Feed - Pull the list of a user's posts from the blockchain.
  2. Steemconnect - Getting started with setting up Steemconnect.
  3. Client-side signing - Generate, sign, verify and broadcast transactions via client-side without Steemconnect.
  4. Get posts with filters - How to query for posts with specific filters & tags.
  5. Get post details - How to get details of each post.
  6. Get voters list on content - How to get voters info on post/comment.
  7. Get post comments - How to fetch all comments made on particular post.
  8. Get account replies - How to get list of latest comments made on content of particular account.
  9. Get account comments - How to get list of comments made by particular account.
  10. Submit post - How properly format and submit post.
  11. Submit comment - How to submit reply to particular post.
  12. Edit content - How to properly patch edited content and submit edits.
  13. Stream blockchain - How to stream blockchain transactions as they accepted by network.
  14. Reblog/Resteem a post - How to reblog/resteem a post
  15. Search accounts - Search for user accounts by partial username.
  16. Search for tags - Search for trending tags.
  17. Vote on content - Create a weighted up or down vote on a comment/post.
  18. Follow a user - Follow and unfollow a user / author.
  19. Get follower & following list - Get the followers of a user/author & the authors that user is following.
  20. Account reputation - Learn how to interpret account reputation.
  21. Transfer STEEM & SBD - Transfer both STEEM and SBD from one account to another.
  22. Witness listing & voting - Create a list of available witnesses as well as vote for and remove your vote for a witness.
  23. Claim rewards - Learn how to claim rewards from unclaimed reward balance using Steemconnect as well as client signing method.
  24. Power up - Power up an account's Steem using either Steemconnect or a client-side signing.
  25. Power down - Perform a power down on all or part of an account's VESTS using either Steemconnect or client-side signing.
  26. Create account - Create Steem account using Steemconnect as well as with client-side signing.
  27. Delegate steem power - Delegate power to other users using Steemconnect or Client-side signing.
  28. Set withdraw route - Set routes to an account's power downs or withdraws.
  29. Get delegations by user - View the vesting delegations made by a user as well as the delegations that are expiring.
  30. Grant posting permission - How to grant and revoke posting permission to another user.

To Run one of the tutorials

Use the command line/terminal for the following instructions

  1. clone this repo

    git clone git@github.com:steemit/devportal-tutorials-js.git

  2. cd into the tutorial you wish to run

    ex: cd tutorials/01_blog_feed

  3. Use npm or yarn to install dependencies

    ex: npm i

  4. Run the tutorial

    npm run dev-server or npm run start

  5. After a few moments, the server should be running at http://localhost:3000/

Production Blockchain vs. Testnet

These tutorials favor use of the production Steem blockchain. However, some produce content that would be spammy. And spam on a blockchain, like everything else on a blockchain, is forever. Eww.

So for those tutorials we use a testnet setup and maintained by user @almost-digital. You can see its current status, and learn how to easily create accounts and connect to it at https://testnet.steem.vc/. And depending on the day, you can even use an outdated version of condenser to crawl it at https://condenser.steem.vc/

Credentials for demo accounts on the testnet are in tutorials/configuration.js`. Because this information is public, someone may have changed the keys of these accounts. If this has happened, you can either wait until the testnet reboots, or create an account or two of your own. It's super easy

Contributing

If you're interested in contributing a tutorial to this repo. Please have a look at the guidelines for the text portion of the tutorial..