Installation
Get started with Igniter.js by choosing your preferred framework and following the installation guide.
Choose your framework to get started with Igniter.js. Each guide provides step-by-step instructions tailored to your development environment.
Framework Guides
Select your framework below for detailed installation and setup instructions:
Next.js
Full-stack React framework with SSR and API routes
Vite
Lightning-fast build tool for modern web projects
Express
Fast, unopinionated web framework for Node.js
Bun
Fast all-in-one JavaScript runtime and toolkit
Deno
Secure runtime for JavaScript and TypeScript
Quick Start
If you're not sure which framework to choose, or want to quickly test Igniter.js features:
Use the CLI
Start a new project with our interactive CLI:
npx @igniter-js/cli@latest initpnpm create igniter-appyarn create igniter-appbunx create-igniter-appChoose your template
The CLI will guide you through:
- Framework selection (Next.js, Vite, Express, etc.)
- TypeScript configuration
- Database setup (optional)
- Additional features (auth, jobs, etc.)
Start developing
cd my-igniter-app
npm run devRequirements
Before installing Igniter.js, ensure you have:
- Node.js 22.0 or higher
- Package Manager: npm, pnpm, yarn, or bun
- TypeScript 5.0 or higher (configured in your project)
TypeScript Required
Igniter.js is built with TypeScript-first principles and requires TypeScript for full type safety and autocomplete features.
What's Next?
After installation, explore the core concepts:
- Builder - Learn how to create your Igniter.js instance
- Router - Understand routing and controllers
- Actions - Create queries and mutations
- Client - Use the auto-generated type-safe client
Need Help?
Join our Discord community or check out GitHub Discussions for support.