Get Started

Getting started with Akte takes a few minutes and consists of two things:

1. Setting up Akte
2. Picking up a development flavor

Akte setup

1. Install Akte

npm install --save-dev akte

2. Create an akte.app.ts¹ file

import { defineAkteApp } from "akte";

export const app = defineAkteApp({
	files: [],
});

Development Flavor

Don't be afraid to make a wrong choice here as you can easily switch between development flavors.

Akte CLI

Akte CLI is minimal and only allows you to build your Akte app. Use it over Vite, when you don't need Vite or just want to experiment with Akte.

To run Akte CLI and build your app, just execute your akte.app.ts file.

node akte.app.js build
npx tsx akte.app.ts build

Your built app will be available in the dist directory.

Vite

Akte integrates with Vite, this allows you to leverage Vite development server and assets processing pipeline to enrich your app.

1. Install additional dependencies²

npm install --save-dev vite html-minifier-terser

2. Create or update your vite.config.ts file

import { defineConfig } from "vite";
import akte from "akte/vite";
import { app } from "./akte.app";

export default defineConfig({
	plugins: [akte({ app })],
});

3. Add .akte to your .gitignore file

.akte

You're ready to start developing your Akte app through Vite.

npx vite
npx vite build

Next steps

Well done! Whether you opted for the CLI or Vite, you're ready to start developing with Akte.

• Check out the guide to learn more about Akte usage ›
• Check out the examples to get inspiration ›