Create an Ethereum Code Tutorial in 4 Steps
This week we release the ChainShot Builder with a simple goal: to help people build great open source educational content.
Over the last few months we’ve enjoyed creating coding tutorials/challenges like Build a JavaScript Blockchain, Intro to Vyper, and Who has my Ether?
Now we want to empower the community to create their own coding tutorials and challenges. And do so by committing to open source content repositories on Github!
It’s quite simple to get started. Here’s the steps you’ll need to take:
Step 1: Setup Builder
To get started, you’ll need the latest version of Node.js. Then you can install the ChainShot Builder CLI globally:
npm i -g chainshot-builder
mkdir myContentFolder
cd myContentFolder
chainshot-builder initBoom! With that, you’ll have spun up the ChainShot Builder IDE:
Step 2: Build The Tutorial or Challenge
This is where it’s up to you to get creative!
Build the tutorial or challenge that will really engage your audience. We’ve got a number of ways to help you get started. You can choose to fork our existing content or you could check out this YouTube video on building content.
Additionally the IDE comes equipped with stage templates that will ensure you start from a working setup:
Any changes saved within the IDE will automatically be reflected in your content folder on your file system. So once you’re happy with your progress, all that’s left is to get your content into source control and deploy it!
Step 3: Create your Github Repository
Head out to Github and create your new repository:
You can name it whatever you like. Then add your new github URL as the remote for your content folder and start committing up changes:
cd myContentFolder
git init
git add .
git commit -m "init"
git remote add origin https://github.com/OWNER/REPO.git
git push origin master Great, all your content is now saved in source control!
Step 4: Deploy to ChainShot
First, you’ll need a ChainShot account on www.chainshot.com
Once you’ve created one, you’ll be able to visit My Content:
From there, you’ll simply need to connect your Github account and select your content repository for deployment. For more information on Linking your Github check out our documentation on the subject!
Once you’ve finished this step your content will be live on ChainShot for users to begin taking your tutorials! Any changes that you make from this point on to your content repository will automatically be deployed to ChainShot.
That’s it!
Well that’s everything for now. If this excites you be sure to jump in our Slack Channel to discuss building content or follow on us on Twitter for more updates.
