blockly

# Blockly

Blockly is a library that adds a visual code editor to web apps. The Blockly editor uses interlocking, graphical blocks to represent code concepts like variables, logical expressions, loops, and more. It allows users to apply programming principles without having to worry about syntax or the intimidation of a blinking cursor on the command line. All code is [free and open source](https://github.com/raspberrypifoundation/blockly/blob/develop/LICENSE).

![An example program built with Blockly that checks for a game over state](./sample.svg)

## Getting Started with Blockly

Blockly has many resources for learning how to use the library. You can [try a live demo](https://raspberrypifoundation.github.io/blockly/packages/blockly/demos/code/index.html) or [visit our developer site](https://docs.blockly.com) to read the documentation on how to get started, configure Blockly, and integrate it into your application. The developer site also contains links to:

- [Getting Started article](https://docs.blockly.com/guides/get-started/what-is-blockly/)
- [Getting Started codelab](https://docs.blockly.com/codelabs/getting-started/codelab-overview/)
- [More codelabs](https://docs.blockly.com/codelabs/)
- [Demos and plugins](https://raspberrypifoundation.github.io/blockly-samples/)

Help us focus our development efforts by filling out a brief [developer survey](https://forms.gle/pdvS57Va4a8xZDAp8) about what you're building with Blockly.

### Installing Blockly

If you're starting a new project using Blockly, you can bootstrap it
using our [`create-package` tool](https://www.npmjs.com/package/@blockly/create-package):

```bash
npx @blockly/create-package app my-cool-blockly-app --typescript
```

Or, if you're adding Blockly to an existing project, just [install it with npm](https://www.npmjs.com/package/blockly):

```bash
npm install blockly
```

### Getting Help

- [Report a bug](https://docs.blockly.com/guides/contribute/get-started/write_a_good_issue/) or file a feature request on GitHub
- Ask a question, or search others' questions, on our [developer forum](https://groups.google.com/forum/#!forum/blockly). You can also drop by to say hello and show us your prototypes; collectively we have a lot of experience and can offer hints which will save you time. We actively monitor the forums and typically respond to questions within 2 working days.

### blockly-samples

We have a number of [examples](https://github.com/raspberrypifoundation/blockly-samples/tree/main/examples) which demonstrate various techniques to include and extend the Blockly library. These examples can be found in another repository called [blockly-samples](https://github.com/raspberrypifoundation/blockly-samples).

### Plugins

A plugin is a self-contained piece of code that adds functionality to Blockly. Plugins can add fields, define themes, create renderers, and much more. For more information, see the [Plugins documentation](https://docs.blockly.com/guides/programming/plugin_overv