This package is an NPM initializer to generate a web application based on the Otter Framework.
This package is simplifying the start of an Otter Framework based application.
npm create @o3r <project-name> -- [...options]
[!WARNING]
yarn create
is not supported.
You can generate an environment with a specific package manager thanks to the --package-manager
options:
npm create @o3r <project-name> -- --package-manager=yarn [...options]
[!NOTE] At the moment, the
package-manager
option only supportsyarn
andnpm
.
You can specify the npm's package registry to use.
npm create @o3r <project-name> --registry=<registry-url> -- [...options]
It will create a project with a .npmrc
file configured to target the specified registry.
If the specified package manager is yarn
, it will also configure the .yarnrc.yml
file.
The generator accepts all the configurations from the Angular ng new
command, see the options list.
On top of them, the following options can be provided to the initializer:
-
--yarn-version
: specify the version of yarn to use (default:latest
) -
--exact-o3r-version
: use a pinned version for Otter packages.