Getting Started

This guide takes you from zero to a working Localess space connected to a frontend.

1. Deploy Localess

Pick the path that matches your goal:

• Production — Deploy on Firebase. Required for live applications.
• Local exploration — Run locally. Spin up the full stack without a Google Cloud project.

Once Localess is running, open <your-instance>/setup to create your first user. The full URL depends on the deployment method.

2. Create your first space

A space is the top-level container for content, translations, assets, and schemas. Sign in to the admin UI and create one. Note the Space ID and generate an API token in Settings → Access Tokens — you'll need both to talk to the API.

3. Define your content

In the admin UI:

1. Go to Schema and create a ROOT schema for your first document type (e.g., page). See Schema → Overview for field types.
2. Go to Content and create a document using that schema.
3. Go to Translations and add the strings your application needs.

4. Pull content into your frontend

Choose the integration that fits your stack:

Minimal example with the JS client:

import { localessClient } from "@localess/client";

const client = localessClient({
  origin: "https://my-localess.web.app",
  spaceId: "YOUR_SPACE_ID",
  token: "YOUR_API_TOKEN", // server-side only
});

const home = await client.getContentBySlug("home", { locale: "en" });
const ui = await client.getTranslations("en");

5. Generate types (recommended)

Once you have schemas defined, use the CLI to generate TypeScript types so getContentBySlug<Page>(...) is fully typed:

npm install @localess/cli -D
npx localess login
npx localess types generate

Details: CLI → Type Generation.

What's next

• Translations — manage UI strings and locales
• Content — author documents and folders
• Visual Editor — preview live edits in your running app
• Schemas — design content models
• API reference — endpoints, parameters, responses