Skip to content

Super-Blockchain-Scaffolder/sbs-master-list

Repository files navigation

sbs-master-list

The master list of starter templates for the Super Blockchain Scaffolder


Updating The List

Want to add your own awesoem project as a starter for the sbs cli tool? Well lucky for you, it's easy!

Just update the sbs-master-list.yaml file in this repository with the necessary information, and that's all there is to it!


Validating The Yaml

We use specifically the StrictYAML flavor of yaml. When you open a pull request CI jobs should automatically kick off to validate that the yaml file with your edits is still valid StrictYAML syntax.

You can run this validation locally by running the python file:

python3 validate-master-list-strict-yaml.py

Python Setup

Make sure you have python version at least 3.10 installed.


How to install?

Virtual environment is already setted up, just activate that by this command and you are good to go!

source sbs-master/bin/activate

Then you can just run this command:

python3 validate-master-list-strict-yaml.py

Note: you may also need to run this:

python3 -m pip install strictyaml

TODO

  • validate that git repo exists for new submissions

  • validate that starters fit a schema

About

The master list of starter templates for the Super Blockchain Scaffolder

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages