create-cloak-app
v3.1.0
Published
Sets up a new Cloak (Nuxt + Craft/Contentful) based project.
Downloads
53
Readme
create-cloak-app
Sets up a new Cloak (Nuxt + CMS) based project. Supported CMSs are Craft, Contentful and @nuxt/content. The goal of this project is to provide a place to store best practices and conventions across projects. Secondarily, the developer should have a functioning Hello World app after running the install command.
Usage
From the directory you want to create the new Cloak app:
# If using @nuxt/content or Craft
yarn create cloak-app
# Use previous major version if Contentful or Shopify
yarn global add create-cloak-app@^2
create-cloak-app
This will ask you a handful of questions, copy relevant files from the template, init a new git repo, and run initial install commands. You will then have a local Nuxt-based app that will be immediately bootable.
After you've created a new cloak-app, there are subsequent steps you'll likely need to take based on your choices. You'll be prompted to visit the following docs pages following a successful completion.
Contributing
- Run
yarn sao ./ ~/Desktop/cloak-app
to create an Cloak instance to iterate on on your desktop. - Track the changes you make to that instance using the git repo that was automatically set up.
- Replay those changes (manually, unless someone has some git brilliance to share), back onto the /template directory as part of a PR.