Skip to content

1.0.0

Choose a tag to compare

@readymade-ui readymade-ui released this 02 Feb 05:35
· 1 commit to main since this release

Example usage: npx primr my-app

The above command generates a new Readymade project in the my-app directory. The script automatically installs the Readymade starter code but could be modified with arguments to instantiate other projects as well.

Options

  • http use https instead of ssh for git clone (default = https://github.com/)
  • repo repo name (default = readymade-ui/starter)
  • script run script after install (default = yarn dev)
  • ssh use ssh instead of https for git clone (default = git@github.com)
  • npm use npm instead of yarn (default is yarn)

Examples

Clone the default readymade-ui/starter repository into a directory called my-app over ssh from a custom git server, install dependencies and run scripts with npm

npx primr my-app --ssh git@custom-git-server.com --npm

Clone another repository into a directory called foo-server, run the serve script post install.

npx primr foo-server --repo steveblue/bazel-typescript-starter --script serve