Docs/Getting Started/Introduction
Introduction
Welcome to the DevKit documentation. DevKit is a modern full-stack framework for building fast, scalable web applications with an excellent developer experience.
System Requirements
- Node.js 18.17 or later
- macOS, Windows, or Linux
- npm, yarn, or pnpm package manager
Automatic Installation
The easiest way to get started is using create-devkit-app, which sets up everything automatically.
Terminal
npx create-devkit-app@latest my-project
cd my-project
npm run devConfiguration Options
During setup, you will be prompted with the following options:
| Option | Default | Description |
|---|---|---|
--typescript | Yes | Enable TypeScript support |
--tailwind | Yes | Initialize Tailwind CSS |
--src-dir | No | Use src/ directory |
--import-alias | @/* | Configure import alias |
Manual Installation
To manually create a new DevKit application, install the required packages:
Terminal
npm install devkit react react-domTip: You can also use yarn or pnpm as your package manager. DevKit automatically detects your preferred package manager.