# Install and configure puck

Follow the source instructions for **puck**. Read the prerequisites and configuration steps before running an example.

## Quick start

Install the package:

```sh
npm i @puckeditor/core --save # or npx create-puck-app my-app
```

Render the editor:

```jsx
// Editor.jsx
import { Puck } from "@puckeditor/core";
import "@puckeditor/core/puck.css";

// Create Puck component config
const config = {
  components: {
    HeadingBlock: {
      fields: {
        children: {
          type: "text",
        },
      },
      render: ({ children }) => {
        return <h1>{children}</h1>;
      },
    },
  },
};

// Describe the initial data
const initialData = {};

// Save the data to your database
const save = (data) => {};

// Render Puck editor
export function Editor() {
  return <Puck config={config} data={initialData} onPublish={save} />;
}
```

Render the page:

```jsx
// Page.jsx
import { Render } from "@puckeditor/core";
import "@puckeditor/core/puck.css";

export function Page() {
  return <Render config={config} data={data} />;
}
```

## Check the installation

After setup, continue with the [first example](/docs/up-to-code-puck/quick-start-guide). If a command fails, compare the runtime version, working directory, and required configuration with the original README before changing dependencies.

## Source and help

- [GitHub repository](https://github.com/Up-to-code/puck)
- [Original README](https://github.com/Up-to-code/puck/blob/main/README.md)
- [Issues and existing reports](https://github.com/Up-to-code/puck/issues)
- [Open the project website](https://puckeditor.com)

The catalog identifies the license as **MIT**. Read the repository license before redistributing source or assets.

This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.