Skip to main content

Installation

Requirements​

LTF Engine is built on top of Bun, a fast and secure runtime for JavaScript and TypeScript.

You can install it with the following command.

macOS/Linux​

curl -fsSL https://bun.sh/install | bash

Windows​

powershell -c "irm https://bun.sh/install.ps1 | iex"

Scaffold project app​

From template​

You can also use a template to create a new project.

bun create latechforce/engine-template my-app

Open the project.

$ cd my-app

Start developing!

bun dev

And your app will be available at http://localhost:3000.

From scratch​

Create a new directory for your project and navigate into it.

$ mkdir my-app
$ cd my-app

Initialize a new Bun project.

bun init

Install LTF Engine:

bun add @latechforce/engine

Create a new bunfig.toml file with the TailwindCSS plugin, required to compile the app CSS.

bunfig.toml
[serve.static]
plugins = ["bun-plugin-tailwind"]

Edit the index.ts file to configure the app.

index.ts
import { App, type AppSchema } from '@latechforce/engine'

const schema: AppSchema = {
  name: 'My app',
  version: '0.0.1',
  description: 'My app description',
}

await new App().start(schema)

Start developing!

bun dev

And your app will be available at http://localhost:3000.