create-zuplo-api 2.3.0 → 6.2.20

package/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Vercel, Inc. Copyright (c) 2024 Zuplo, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,16 +1,127 @@
-# create-zuplo-api
+# Create Zuplo API
 
-The official way to create a new Zuplo API Gateway.
+Create a new Zuplo API in seconds with `create-zuplo-api`.
 
-<p align="center">
-  <img src="https://github.com/zuplo/zuplo/blob/main/media/screenshot-cli.png?raw=true" width="800">
-</p>
+### Interactive
 
-## Usage
+You can create a new project interactively by running:
 
-```sh
+```bash
 npm create zuplo-api@latest
+# or
+yarn create zuplo-api
+# or
+pnpm create zuplo-api
+# or
+bunx create-zuplo-api
 ```
 
-Do not omit the @latest tag, otherwise `npm` may resolve to a cached and
-outdated version of this package.
+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.
+
+### Non-interactive
+
+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 <path-to-example>
+
+    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
+```
+
+### Why use Create Zuplo API?
+
+`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`).