Skip to content

quick-start.md

Latest commit

 

History

History
66 lines (38 loc) · 2.36 KB

quick-start.md

File metadata and controls

66 lines (38 loc) · 2.36 KB
Raw
sidebar_position 1
description Quick start guide

import StackBlitzGithub from '@site/src/components/StackBlitzGithub'; import ZModelStarter from '../_components/_zmodel-starter.md'; import PackageInstall from '../_components/PackageInstall'; import PackageExec from '../_components/PackageExec'; import PackageDlx from '../_components/PackageDlx';

Quick Start

There are several ways to start using ZenStack ORM.

1. Creating a project from scratch

Run the following command to scaffold a new project with a pre-configured minimal starter:

npm create zenstack my-project

Or simply use the following interactive playground to experience it inside the browser.

2. Adding to an existing project

To add ZenStack to an existing project, run the CLI init command to install dependencies and create a sample schema:

Then create a zenstack/schema.zmodel file in the root of your project. You can use the following sample schema to get started:

Finally, run zen generate to compile the schema into TypeScript. Optionally, run zen db push to push the schema to the database.

3. Manual setup

You can also always configure a project manually with the following steps:

  1. Install dependencies

<PackageInstall devDependencies={['@zenstackhq/cli']} dependencies={['@zenstackhq/schema', '@zenstackhq/orm']} />

  1. Create a zenstack/schema.zmodel file

You can use the following sample schema to get started:

  1. Run the CLI generate command to compile the schema into TypeScript

:::info

By default, ZenStack CLI loads the schema from zenstack/schema.zmodel. You can change this by passing the --schema option. TypeScript files are by default generated to the same directory as the schema file. You can change this by passing the --output option. The default settings can also be changed as explained in the CLI reference.

You can choose to either commit the generated TypeScript files to your source control (recommended), or add them to .gitignore and generate them on the fly in your CI/CD pipeline.

:::