Getting Started Introduction
This page provides a step-by-step guide to getting started using the Superblocks platform.
- Existing GitHub account or the ability to create one;
- Existing GitHub repository with a smart contract (assuming you would like to start building);
- You can fork this repository to try it out.
Setting up your first project on Superblocks
After logging in, you will be redirected to the Superblocks platform Welcome screen. Filter and select the repository you would like to build, preferably one with a smart contract in it (reference example). Use the drop-down to the right to filter between different GitHub organizations. Once you have found your repository, press Select Repository.
You will be redirected to GitHub and asked to approve and install Superblocks. Choose whether you want to grant access to all repositories or just the selected one. Once you are back at the welcome screen, Configure your pipeline by choosing one of the existing templates. Following the Ethereum reference project, pick Truffle by pressing the Set up this pipeline button.
The last step is to review the initial pipeline configuration. When ready, press the Commit and Run button. This will save the
superblocks.yamlfile by committing to the repository’s master branch (default settings).
You have now successfully connected your repository and are ready to start building! Your screen should look like this:
Running your first Superblocks build
Superblocks automatically triggers a build everytime a push event happens in the selected GitHub repository.
Start by committing a change to the connected GitHub repository in your preferred manner. Once the Superblocks platform is refreshed, it will show a build has automatically started running.
List all the involved builds by inspecting the Jobs section.
Back to the Pipelines section, press the Status or the Build identifier to check the Pipeline details:
Eventually the build will succeed or fail. In case you would like to see the Logs for a specific Job, access it by pressing any of the boxes in the Pipelines details. Or click the build Status or the Build identifier in the Jobs section. Read more about the default configuration here.
If the build failed, you can opt to retry it from within the Superblocks platform. Have a go and break something to test it out! You can also query the commit by clicking on the provided links.
Finally you and your team will be able to see the result of your commits in your GitHub pull requests. Good luck!
Setting up your organization
When you log in for the first time and create a project, Superblocks will have automatically created an organization for you. The automatically created organization is named after your GitHub username. You can reach the organization screen by either clicking the Superblocks logo in the top left corner of the screen, or navigating using the breadcrumb at the top.
At the highest level, Superblocks is structured around the concept of organizations. Each organization consists of one or more projects (repositories with smart contracts) and people. This helps users have an overview of all the projects linked to their organization and who has access.
If you are involved with projects in several organizations, such as a consultancy, working with different clients, then you will easily be able to see and jump between all organizations in a single view.
You can choose the following actions in the organization page:
- Projects: Create a new project, or filter for existing projects.
- People: Invite or remove people from the organization. Manage their access roles.
- Settings: Rename, edit organization description, or delete the organization (Note: your organization’s URL does not change when you rename your organization).
You can also choose to create new organizations from scratch.
Role-based access control
In each organization it is possible to invite other people and provide them with different levels of access. There are two defined roles:
- Member: Has the ability to create new projects, view every participating member, view and manage builds.
- Owner: All of the above, including full administrative access. Administrators are allowed to modify other people’s access rights, invite or remove members, delete projects, and delete the entire organization.
Where to go for assistance
If you have questions or troubles then please don’t hesitate to explore the following:
Community Forum - https://discuss.superblocks.com/
Support Desk - https://help.superblocks.com/
Superblocks Blog - https://superblocks.com/blog/
Developers Discord - https://discordapp.com/invite/6Cgg2Dw