https://github.com/ignatandrei/visualapi_githubnextblocks
Visual API - LowCode Blocklly for Github Next Blocks
https://github.com/ignatandrei/visualapi_githubnextblocks
github-blocks
Last synced: 4 months ago
JSON representation
Visual API - LowCode Blocklly for Github Next Blocks
- Host: GitHub
- URL: https://github.com/ignatandrei/visualapi_githubnextblocks
- Owner: ignatandrei
- License: mit
- Created: 2023-03-08T18:43:43.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-06-06T02:32:43.000Z (over 2 years ago)
- Last Synced: 2025-04-04T23:41:51.415Z (10 months ago)
- Topics: github-blocks
- Language: TypeScript
- Homepage:
- Size: 1.21 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# GitHub Blocks Template
Use this repository as a starter template for building your own Blocks.
## Quickstart
> 🛑 Currently, you must be flagged into the [GitHub Blocks Technical Preview](https://blocks.githubnext.com) in order to develop blocks. There is no "offline" development mode at this time.
Fork this repo using the [`Use this template`](https://github.com/githubnext/blocks-template/generate) button above:
Then, clone _your_ repo (not [this one!](https://github.com/githubnext/blocks-template)) and get ready for action:
```bash
yarn # install dependencies
yarn start # start the dev server
# Or use npm, pnpm, you know the drill
```
When you visit [localhost:4000](https://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](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!
## Under the hood
Currently, Blocks are [React](https://reactjs.org/) components. They have a well-defined contract with their surroundings, and receive a [fixed set of props](https://github.com/githubnext/blocks/blob/main/docs/Developing%20blocks/4%20API%20reference%20and%20types.md) when they are instantiated. They are developed in [TypeScript](https://www.typescriptlang.org/), and bundled with [Vite](https://vitejs.dev/).
## More Info
Visit [githubnext/blocks](https://blocks.githubnext.com/githubnext/blocks) for a full tutorial, documentation, and examples.
You should also join us in our discord! There's a [#blocks channel](https://discord.com/channels/735557230698692749/1039950186136469535) where you can connect with us and other folks who are building Blocks:
> 👋 https://discord.gg/githubnext
## License
MIT
✌️ ❤️
_GitHub Next_