create-swiftjs-app

The easiest way to get started with SwiftJS.

Quick Start

Run the command and follow the interactive prompts:

npx create-swiftjs-app my-app

Or using npm init:

npm init swiftjs-app my-app

Templates

We provide several templates to get you started quickly:

🚀 Basic API

A minimal setup with a simple route handler. Perfect for learning the basics or building small microservices.

npx create-swiftjs-app my-app --template basic

📁 File Router (Recommended)

A scalable structure using file-based routing convention (*.get.ts, *.post.ts). Includes validation, error handling, and structured organization.

npx create-swiftjs-app my-app --template file-router

⚡ AWS Lambda

A serverless-ready setup pre-configured for deployment to AWS Lambda using the SwiftJS Lambda adapter.

npx create-swiftjs-app my-app --template lambda

Features for All Templates

• TypeScript: Fully typed codebase out of the box.
• Modern Tooling: Fast builds and dev server with esbuild and tsx.
• Linting & Formatting: Configured with ESLint and Prettier.
• Git Ready: Automatically initializes a git repository.

Post-Installation

Once your project is created:

1. Navigate to the directory:

   cd my-app

2. Install dependencies:

   npm install

3. Start the dev server:

   npm run dev

Open http://localhost:3000 to see your app running.

License

MIT © AshAvi