Akte Logov0.4.0 - GitHub

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

Don't want to commit yet?

Have a look at the examples to get a feeling of what Akte looks like, some are even available on Stackblitz.

Akte setup

  1. Install Akte
npm install --save-dev akte
  1. Create an akte.app.ts1 file
import { defineAkteApp } from "akte";

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

Configuration

Discover more configuration options in the app configuration ›

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.

Usage

Discover more about the CLI usage in the CLI references ›

Vite

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

  1. Install additional dependencies2
npm install --save-dev vite html-minifier-terser
  1. 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 })],
});
  1. Add .akte to your .gitignore file
.akte

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

npx vite
npx vite build

Configuration

Discover more configuration options in the Vite plugin configuration ›

Next steps

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

Footnotes

  1. Akte also works with plain JavaScript! While most of the snippets in the documentation are TypeScript, don't be afraid of them. Everything works the same way or is indicated so when otherwise~ ↩

  2. You can omit html-minifier-terser if you don't want HTML to be minified by Akte. You will need to disable explicitly the minifyHTML option of the Vite plugin, see its configuration. ↩