Giter Club home page Giter Club logo

kickstart-substrate's Introduction

kickstart-substrate

This pulls from an actively updated branch of Substrate's node template. It runs a script in template.toml which makes it easy to customize a node template. Customize is a big word. For now it does the little things:

  1. Renames the template pallet.
  2. Renames the node.

🧐 How to use it

Install kickstart (you'll only need to do this once):

cargo install kickstart

cd in the directory you'd like this project to live in and run:

kickstart https://github.com/sacha-l/kickstart-substrate

Then, you'll be prompted to type in the pallet and node names.

If you want to specify a folder to clone into, run:

mkdir <folder_name>
kickstart https://github.com/sacha-l/kickstart-substrate -o <folder_name>

Maintanence note

To ensure submodule is updated, run:

git submodule update --remote --merge

⌛ Coming soon™️

  • A way to add more pallets from the CLI using Tera.
  • A way to do some basic pallet scaffolding based on user input. For example, storage items; events; errors.
  • Ask user if they're using the template for production. If yes, handle the renaming of author and project repositories.

🙏 Acknowledgements

Thanks to Keats for making the Kickstart tool and for Chevdor for showing it to me!

Contribute

This repo contains submodules, make sure you initialize them by cloning with:

git clone --recurse-submodules [email protected]:chevdor/kickstart-substrate.git

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.