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

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:
> Terminal
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:
> Terminal
git clone https://github.com/unistudioco/squeditor-framework.git
Then, scaffold a new project using this:
> Terminal
npm run scaffold your-project-name
Replace your-project-name with your desired project name.
2

Development

Navigate into your newly generated project folder, install its dependencies, and start the development server:
> Terminal
cd your-project-name
npm install
npm run dev
Use Port 3001 for DevelopmentVite 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.
3

Build for Production

This will generate the static dist/ folder and a distributable ZIP archive:
> Terminal
npm run build