Installation

Get Frame-Master up and running in minutes. This guide covers installation methods, system requirements, and initial project setup.

Prerequisites

Before installing Frame-Master, ensure you have the following installed on your system:

Bun.js

Frame-Master is built exclusively for the Bun runtime.

≥ 1.2.0

Installation:

curl -fsSL https://bun.sh/install | bash

Verify:

bun --version

View Documentation↗

Node.js

Optional

Only needed if you're using Node.js-based tools alongside Frame-Master.

≥ 18.0.0

Installation:

# Visit nodejs.org for installation instructions

Verify:

node --version

View Documentation↗

Installation Methods

Global Installation

Recommended

Install Frame-Master globally to use it across multiple projects.

terminal

bun add -g frame-master

After installation, you can use the frame-master command from anywhere in your terminal.

Project-Specific Installation

Install Frame-Master as a dependency in your project.

terminal

bun add frame-master

Use this method if you want Frame-Master versioned with your project. Run commands with bun frame-master.

Run Without Installing

Execute Frame-Master commands without installing it globally.

terminal

bunx frame-master create my-app

Perfect for trying Frame-Master or running one-off commands. The bunx command downloads and executes the latest version on demand.

Verify Installation

After installation, verify that Frame-Master is correctly installed:

terminal

# Check Frame-Master version
frame-master --version

# View available commands
frame-master --help

✅

Success!

If you see the version number and help menu, Frame-Master is installed correctly and ready to use.

Create Your First Project

You have two options to start a new Frame-Master project:

Option 1: Create a New Project

Recommended

Use the create command to set up a new project in a fresh directory:

terminal

# Create a new project
bun frame-master create my-app

# Navigate to your project
cd my-app

# Start development server
bun frame-master dev

💡

What the create command does:

Creates a new directory with your project name
Generates frame-master.config.ts configuration file
Sets up .frame-master/ directory with internals
Configures TypeScript settings
Installs all required dependencies

Option 2: Initialize in Existing Project

Use the init command to add Frame-Master to an existing project:

terminal

# In your existing project directory
bun frame-master init

# Start development server
bun frame-master dev

⚠️

Use this when:

You have an existing project you want to migrate
You've already created a directory for your project
You want to add Frame-Master to a monorepo package

Troubleshooting

⚠️Command not found: frame-master

If you installed globally, make sure Bun's global bin directory is in your PATH. Try running 'bun frame-master' instead, or reinstall with 'bun add -g frame-master'.

⚠️Port already in use

Another process is using port 3000. Either stop that process or change the port in your frame-master.config.ts file.

⚠️Module not found errors

Run 'bun install' to ensure all dependencies are installed. If the error persists, try deleting node_modules and bun.lockb, then run 'bun install' again.

⚠️TypeScript errors

Make sure your tsconfig.json is properly configured. The 'frame-master init' command sets this up automatically, but manual changes might cause issues.

Next Steps

Now that Frame-Master is installed, you're ready to start building:

🚀

Quickstart Guide

Follow our step-by-step guide to build your first Frame-Master app.

Learn more→

🔌

Plugin System

Learn how to use and create plugins to extend Frame-Master.

Learn more→

⚙️

Configuration

Deep dive into Frame-Master configuration options.

Learn more→

��

Project Structure

Understand the anatomy of a Frame-Master project.

Learn more→