This repository is based on a starter template for building your own Blocks.

vezwork's note: I've made it so that this repo has Polytope as a submodule. If you are cloning this repo, I believe you will have to run:

git submodule init
git submodule update

Note also that pulling will not be enough, you will also have to run git submodule update. Then you can run:

yarn # install dependencies
yarn start # start the dev server
# Or use npm, pnpm, you know the drill

When you visit localhost:4000 in your browser, you'll be redirected to the Blocks app, but your locally-developed blocks will appear in the block picker:

(if you're using Safari (or another browser that doesn't permit calling http URLs from an https page), run yarn start-https and visit https://localhost:4000 instead.)

This template includes one example File Block and one Folder Block. The dev server supports hot reloading, so make some changes, and see what they do!

Currently, Blocks are React components. They have a well-defined contract with their surroundings, and receive a fixed set of props when they are instantiated. They are developed in TypeScript, and bundled with Vite.

Visit githubnext/blocks for a full tutorial, documentation, and examples.

You should also join us in our discord! There's a #blocks channel where you can connect with us and other folks who are building Blocks:

👋 https://discord.gg/githubnext

MIT

✌️ ❤️ GitHub Next