Skip to content

Compas examples

Examples of how to do various tasks with Compas. These examples can be used via with create-compas to quickly start a new project.

# Via NPM
npx create-compas@latest
# Or with Yarn
yarn create compas


Any Compas provided template can be used via npx create-compas@latest --template [template-name]

  • default: This is the default template that is used. It contains boilerplate and conventions to create your api's.

  • with-auth: Based on the default teplate, adds a basic register and loginc system, using @compas/store powered sessions.


Usage: create-compas

Initialize Compas projects based on Compas examples or a custom repository.

- yarn create compas
- npx create-compas@latest
- npx create-compas@latest --template with-auth
- npx create-compas@latest --template github:user/repo --output-directory ./my-project
- npx create-compas@latest --template github:user/repo --template-path ./path/to/scaffold --template-ref v1.0

- Docs:
- Provided templates:

Supported templates:
- Examples from the Compas repository, for example 'default'.
- Your own templates via their Git repository. Currently, only 'github:user/repo' is supported.

Note that for templates from the Compas repository, the default value for '--template-ref'
is based on the 'create-compas' version that you are using. To use the latest example version,
specify '--template-ref main'.

  --help              Display information about the current command. (boolean)
  --template          Specify Compas example or custom repository. (string)
  --template-path     Use a subdirectory from the provided template repository. (string)
  --template-ref      Use a specific branch, tag or commit. (string)
  --output-directory  Use the provided directory instead of the current directory. (string)