Browse documentation
DOCS/Getting started

Getting Started

Full public documentation is available at https://exetjs.com/.

Requirements

Install dependencies in this monorepo

pnpm install
pnpm build

Run CLI in development mode

pnpm --filter @exetjs/cli dev -- --help

Generate a new app

pnpm --filter @exetjs/cli dev -- init my-api
cd my-api
pnpm install
pnpm start

After publishing or global linking, the intended command is:

exet init my-api
cd my-api
exet start

Install a module

exet list
exet install auth

Database connection templates are also available:

exet install db-mongo
exet install db-postgres
exet install db-mysql
exet install db-mariadb
exet install db-sqlite

After installing a module, review the new .env.example entries and configure the actual runtime environment. See Auth module and Database modules before production use.

Validate the project

exet doctor
pnpm run check
pnpm run build