Skip to content

Latest commit

 

History

History
37 lines (23 loc) · 1.28 KB

README.md

File metadata and controls

37 lines (23 loc) · 1.28 KB
Raw

Piral Logo

Pilet Template - Default · GitHub License

This is the default scaffolding template for a new pilet.

Usage

Use the template with pilet new or npm init pilet:

# directly via the CLI (prefer to prefix with npx)
pilet new <app-shell> --template default <other-options>

# via the initializer - best option (NPM v6)
npm init pilet --source <app-shell> --template default <other-options>

# via the initializer - best option (NPM v7 and v8)
npm init pilet -- --source <app-shell> --template default <other-options>

Variables

The following variables are available when scaffolding. They can be applied via the CLI flags, e.g.,

pilet new <app-shell> --template default --vars.foo "bar" --vars.qxz "something else"

For this template we have:

  • src: Sets the directory of the source files. By default it's <root>/src.
  • plugins: Sets the app shell's plugins to consider. By default it's derived from the used Piral instance.

License

Piral is released using the MIT license. For more information see the license file.