Create Zuplo API

Create a new Zuplo API in seconds with create-zuplo-api.

$3

You can create a new project interactively by running:

``bash
npm create zuplo-api@latest


or

yarn create zuplo-api

or

pnpm create zuplo-api

or

bunx create-zuplo-api
`

You will be asked for the name of your project, and then whether you want to
create a TypeScript project:

`bash
✔ Would you like to use TypeScript? … No / Yes
`

Select Yes to install the necessary types/dependencies and create a new TS
project.

$3

You can also pass command line arguments to set up a new project
non-interactively. See create-zuplo-api --help:

`bash
Usage: create-zuplo-api [project-directory] [options]

Options:
-V, --version output the version number
--ts, --typescript

Initialize as a TypeScript project. (default)

--js, --javascript

Initialize as a JavaScript project.

--eslint

Initialize with ESLint config.

--prettier

Initialize with Prettier config.

--empty

Initialize an empty project.

--use-npm

Explicitly tell the CLI to bootstrap the application using npm

--use-pnpm

Explicitly tell the CLI to bootstrap the application using pnpm

--use-yarn

Explicitly tell the CLI to bootstrap the application using Yarn

--use-bun

Explicitly tell the CLI to bootstrap the application using Bun

--no-install

Explicitly tell the CLI to skip installing packages

--no-git

Explicitly tell the CLI to skip initialing the project as a git repository

--no-version-check

Explicitly tell the CLI to skip checking for the latest version of the CLI

-e, --example [name]|[github-url]

An example to bootstrap the app with. You can use an example name
from the official Zuplo repo or a GitHub URL. The URL can use
any branch and/or subdirectory

--example-path

In a rare case, your GitHub URL might contain a branch name with
a slash (e.g. bug/fix-1) and the path to the example (e.g. foo/bar).
In this case, you must specify the path to the example separately:
--example-path foo/bar

--reset-preferences

Explicitly tell the CLI to reset any stored preferences

--yes

Use previous preferences or defaults for all options that were not
explicitly specified, without prompting.

-h, --help display help for command
`

$3

create-zuplo-api allows you to create a new Zuplo API within seconds. It is
officially maintained by the creators of Zuplo, and includes a number of
benefits:

- Interactive Experience: Running npm create zuplo-api@latest (with no
arguments) launches an interactive experience that guides you through setting
up a project.
- Zero Dependencies: Initializing a project is as quick as one second.
Create Zuplo API has zero dependencies.
- Offline Support: Create Zuplo API will automatically detect if you're
offline and bootstrap your project using your local package cache.
- Support for Examples: Create Zuplo API can bootstrap your API using an
example from the Zuplo examples collection (e.g.
npx create-zuplo-api --example my-api`).