Quick Start Guide
Get up and running with Irresistible in less than 5 minutes.
Prerequisites
Before you begin, make sure you have the following installed:
- Node.js 16.x or later
- npm, yarn, or pnpm package manager
- Git version control
Installation Steps
1 Install the CLI
Get started by installing our command-line interface
npm install -g @irresistible/cli
# or
yarn global add @irresistible/cli
# or
pnpm add -g @irresistible/cli
2 Create a new project
Use the CLI to scaffold a new project with your preferred framework
irresistible create my-app
# or with a specific template
irresistible create my-app --template react
irresistible create my-app --template vue
irresistible create my-app --template svelte
3 Start the development server
Run your project locally with hot module replacement
cd my-app
npm run dev
# Your app is now running at http://localhost:3000
4 Deploy to production
Deploy your application with a single command
irresistible deploy
# Your app is now live at https://my-app.irresistible.app
Supported Frameworks
Irresistible supports all major frontend frameworks out of the box:
React
Vue
Svelte
Next.js
Nuxt
SvelteKit
Project Structure
After creating a new project, you'll have the following structure:
my-app/
├── src/ # Source code
│ ├── components/ # Reusable components
│ ├── pages/ # Page components
│ ├── styles/ # Global styles
│ └── main.js # Entry point
├── public/ # Static assets
├── .irresistible/ # Irresistible config
├── package.json # Dependencies
├── irresistible.config.js # Configuration
└── README.md # Documentation
Next Steps
Need Help?
If you run into any issues, we're here to help!