https://github.com/bkwld/create-cloak-app
Sets up a new Cloak (Nuxt + Craft/Contentful) based project.
https://github.com/bkwld/create-cloak-app
contentful craftcms nuxtjs
Last synced: 5 days ago
JSON representation
Sets up a new Cloak (Nuxt + Craft/Contentful) based project.
- Host: GitHub
- URL: https://github.com/bkwld/create-cloak-app
- Owner: BKWLD
- License: mit
- Created: 2021-07-08T00:00:25.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-02-08T23:34:45.000Z (about 2 years ago)
- Last Synced: 2025-03-30T11:01:59.131Z (28 days ago)
- Topics: contentful, craftcms, nuxtjs
- Language: CoffeeScript
- Homepage:
- Size: 1010 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# create-cloak-app
Sets up a new [Cloak](https://github.com/BKWLD/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:
```sh
# 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](./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.
- [Provision Netlify apps](https://bukwild.slab.com/posts/provision-netlify-app-f3fbea34)
- [Deploy & Configure Craft](https://bukwild.slab.com/posts/deploy-configure-craft-rc0v20z4)
- [Setup Custom Storefront Infrastructure](https://bukwild.slab.com/posts/configure-shopify-da1tf5wt)
## Contributing
1. Run `yarn sao ./ ~/Desktop/cloak-app` to create an Cloak instance to iterate on on your desktop.
2. Track the changes you make to that instance using the git repo that was automatically set up.
3. Replay those changes (manually, unless someone has some git brilliance to share), back onto the /template directory as part of a PR.