> ## Documentation Index
> Fetch the complete documentation index at: https://docs.squeditor.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get started with Squeditor Framework.

Follow these steps to set up your workspace, scaffold a new project, and start development.

<Steps>
  <Step title="Scaffold a New Project">
    Squeditor Framework includes a robust CLI scaffolding tool. It generates a completely clean, minimalist project instance fully pre-configured to utilize the advanced GSAP and UIKit engines without demo bloat.

    To scaffold your new project and install `@squeditor-framework`, simply run the following command in your terminal:

    ```bash > Terminal theme={null}
    npx @squeditor/squeditor-framework your-project-name
    ```

    ### Alternative: Manual Setup

    If you prefer to set up the project manually, you can clone the framework repository via:

    ```bash > Terminal theme={null}
    git clone https://github.com/unistudioco/squeditor-framework.git
    ```

    Then, scaffold a new project using this:

    ```bash > Terminal theme={null}
    npm run scaffold your-project-name
    ```

    <Note>Replace <Badge color="blue">your-project-name</Badge> with your desired project name.</Note>
  </Step>

  <Step title="Development">
    Navigate into your newly generated project folder, install its dependencies, and start the development server:

    ```bash > Terminal theme={null}
    cd your-project-name
    npm install
    npm run dev
    ```

    <Warning>
      **Use Port 3001 for Development**

      Vite will show a link to `http://127.0.0.1:5173/` in your terminal. **Do not use that link.**

      Instead, always visit the PHP Server address: **`http://127.0.0.1:3001`**. This is because Squeditor Framework uses PHP for template rendering, and Vite only serves the static assets.
    </Warning>
  </Step>

  <Step title="Build for Production">
    This will generate the static `dist/` folder and a distributable ZIP archive:

    ```bash > Terminal theme={null}
    npm run build
    ```
  </Step>
</Steps>