Installation & Setup
Get started with Irresistible in just a few minutes. This guide will walk you through the installation process and initial setup.
Prerequisites
Before you begin, make sure you have the following installed:
- Node.js version 18.0 or higher
- npm, yarn, or bun package manager
- Git for version control
- A modern web browser (Chrome, Firefox, Safari, or Edge)
Quick Start
1. Create an Account
First, sign up for a free Irresistible account:
# Visit https://irresistible.dev/signup
# Or use the CLI
npx irresistible auth signup
2. Install the CLI
Install the Irresistible CLI globally:
# Using npm
npm install -g @irresistible/cli
# Using yarn
yarn global add @irresistible/cli
# Using bun
bun add -g @irresistible/cli
3. Authenticate
Log in to your account via the CLI:
irresistible auth login
This will open your browser for authentication. Once complete, your credentials will be securely stored.
Creating Your First Project
Using the CLI
The fastest way to create a new project:
# Create a new project
irresistible create my-app
# Navigate to the project directory
cd my-app
# Start the development server
irresistible dev
Using the Dashboard
- Go to your dashboard
- Click “New Project”
- Choose a template or start from scratch
- Give your project a name
- Click “Create Project”
Project Templates
We offer several templates to get you started quickly:
SaaS Starter
irresistible create my-saas --template saas
- User authentication
- Stripe integration
- Admin dashboard
- Email system
E-commerce
irresistible create my-store --template ecommerce
- Product catalog
- Shopping cart
- Payment processing
- Order management
Blog
irresistible create my-blog --template blog
- Markdown support
- SEO optimized
- RSS feed
- Comment system
Custom
irresistible create my-app --template custom
- Choose your framework
- Select features
- Configure integrations
Configuration
Environment Variables
Create a .env
file in your project root:
# Irresistible API
IRRESISTIBLE_API_KEY=your_api_key
IRRESISTIBLE_PROJECT_ID=your_project_id
# Database (if using)
DATABASE_URL=your_database_url
# Other services
STRIPE_SECRET_KEY=your_stripe_key
SENDGRID_API_KEY=your_sendgrid_key
Project Configuration
Your irresistible.config.js
file:
export default {
// Project settings
name: 'my-app',
framework: 'sveltekit',
// Build settings
build: {
output: 'dist',
target: 'node18'
},
// Deployment settings
deploy: {
region: 'us-east-1',
environment: 'production'
},
// AI Assistant settings
ai: {
personality: 'professional',
contextLimit: 4000
}
}
Framework Support
Irresistible supports all major frameworks:
SvelteKit
irresistible create my-app --framework sveltekit
Next.js
irresistible create my-app --framework nextjs
Nuxt
irresistible create my-app --framework nuxt
Remix
irresistible create my-app --framework remix
Vanilla
irresistible create my-app --framework vanilla
VS Code Extension
For the best experience, install our VS Code extension:
- Open VS Code
- Go to Extensions (Cmd+Shift+X)
- Search for “Irresistible”
- Click Install
Features:
- Syntax highlighting
- AI autocomplete
- Live collaboration
- Integrated deployment
Troubleshooting
Common Issues
Installation fails
# Clear npm cache
npm cache clean --force
# Try with sudo (macOS/Linux)
sudo npm install -g @irresistible/cli
Authentication issues
# Clear stored credentials
irresistible auth logout
# Login again
irresistible auth login
Port already in use
# Use a different port
irresistible dev --port 3001
Getting Help
- Check our FAQ
- Join our Discord community
- Email support at support@irresistible.dev
Next Steps
Now that you have Irresistible installed: