# builder

**Repository Path**: mirrors_kevva/builder

## Basic Information

- **Project Name**: builder
- **Description**: Drag and drop page building for any site
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<img alt="BUILDER" src="https://imgur.com/kmKRnra.gif" width="300" />

### Drag and drop page building for _any_ site.

<br />
<br />
<img src="https://imgur.com/lHDo3Mq.gif" alt="Editor example" />

## We're hiring!

Want to work on the future of visual software development? Email me at steve@builder.io and let's talk

## John the community!

Questions? Requests? Feedback? Chat with us in our [Spectrum Community!](https://spectrum.chat/builder)

## How does it work?

- Integrate the [Builder API or SDK](#supported-frameworks) to your site or app
- Create a free account on [builder.io](https://builder.io) and drag and drop to create and publish pages
- Profit

## What is it good for?

- Landing pages
- Marketing pages (Homepage, promotions, etc)
- Content pages (About, FAQ, help, docs, etc)
- Freedom from marketing teams that never stop asking for new things
- Developers who are tired of pushing pixels

## Supported Frameworks

| Framework                                                    |                            Status                             |
| ------------------------------------------------------------ | :-----------------------------------------------------------: |
| [REST API](https://builder.io/c/docs/getting-started)        |                            Stable                             |
| [React](#getting-started-with-react)                         |                            Stable                             |
| [Next.js](packages/react/examples/next-js)                   |                            Stable                             |
| [Webcomponents](https://builder.io/c/docs/webcomponents-sdk) |                            Stable                             |
| [Angular](packages/angular)                                  |                            Stable                             |
| [React native](packages/react-native)                        |                             Beta                              |
| Email                                                        |                            Stable                             |
| AMP                                                          |                            Stable                             |
| Preact                                                       |                            Stable                             |
| **Everyting else** <br/> Go, Php, Java, Vue, Ruby/Rails, Vanilla JS, etc | Use our [HTML API](https://builder.io/c/docs/getting-started) |

Want suppoert for something not listed here or for us to priotize something coming soon? Drop us an issue and let us know! We prioritize based on the community's needs and interests.

## What's in this repository?

This repo houses all of the various [SDKs](packages), [usage examples](examples), [starter projects](starters), and [plugins](plugins)

## Quick start

To start on a fresh project quickly, take a look at our [react starter](starters/react). To integrate Builder to an existing project take a look at the instructions below

## Getting Started with React

```sh
npm install --save @builder.io/react
```

Grab a free account at [builder.io](https://builder.io) and find your [API key](https://builder.io/account/organization)

Next, create a new page in Builder with URL `/something` and publish it.

Then, in your code:

```ts
import { builder, BuilderComponent } from '@builder.io/react';

builder.init(YOUR_KEY);
```

And in your router

```tsx
<Route path="/something" render={() => <BuilderComponent model="page" />}>
```

Create a new page with url "/something" in Builder and change the [preview URL](https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F4670438a077f497d8a486f890201ae85) to localhost:port/something (e.g. localhost:8888/something if your dev server is on port 8888) and edit!

### Try it in CodeSandbox

[Open this example in CodeSandbox](https://codesandbox.io/s/github/BuilderIO/builder/tree/master/examples/react)

<a target="_blank" href="https://codesandbox.io/s/github/BuilderIO/builder/tree/master/examples/react">
  <img src="https://i.imgur.com/zue72Q0.jpg" width="400">
</a>

### Using your components

Wrap a component

```tsx
import { withBuilder } from '@builder.io/react';

class SimpleText extends React.Component {
  render() {
    return <h1>{this.props.text}</h1>;
  }
}

export default withBuilder(SimpleText, {
  name: 'Simple Text',
  inputs: [{ name: 'text', type: 'string' }],
})

```

Then back at your page

```tsx
import './simple-text'

// ...

<Route path="/something" render={() => <BuilderComponent model="page">}>
```

Open the dashboard and use it!

See our [docs site](https://builder.io/c/docs/custom-react-components) for additional help and information, or contact us if you run into any issues or questions!

For lots of examples of using React components in Builder, see the source for our built-in Builder blocks [here](https://github.com/BuilderIO/builder/tree/master/packages/react/src/blocks) and widgets [here](https://github.com/BuilderIO/builder/tree/master/packages/widgets/src/components)



### Dynamic landing pages

One of Builder's most powerful features is allowing the creation of new pages for you. See a simple example of how to do this with react-router below:

```tsx
class CatchAllPage extends Component {
  state = {
    notFound: false,
  };

  render() {
    return !this.props.notFound ? (
      <BuilderComponent
        name="page"
        contentLoaded={content => {
          if (!content) {
            this.setState({ notFound: true });
          }
        }}
      >
        Loading...
      </BuilderComponent>
    ) : (
      <NotFound /> // Your 404 component
    );
  }
}

// Then in your app.js
export default () => (
  <Switch>
    <Route path="/" component={Home} />
    {/* Your other routes... */}
    <Route component={CatchAllPage} />
  </Switch>
);
```

For more advanced usage, like checking for page existence/404 on the server using the Content API, see our detail landing page docs [here](https://builder.io/c/docs/custom-landing-pages) or if using Next.js see our docs for that [here](https://github.com/BuilderIO/builder/tree/master/packages/react/examples/next-js#dynamic-landing-pages)

## Don't use React?

Our [HTML API](https://builder.io/c/docs/getting-started) works for any site

```javascript
let page = await request(
  `https://cdn.builder.io/api/v1/html/page?url=${PAGE_URL}&apiKey=${YOUR_KEY}`
);
if (page) {
  let html = page.data.html;
  // Put the html in your page template between your header and footer and you are done!
}
```

## Troubleshooting and feedback

Problems? Requests? Open an issue. We always want to hear feedback and interesting new use cases and are happy to help.