create-206-app
v0.4.4
Published
Create Studio 206 apps with one command
Downloads
1
Readme
Create 206 App.
This is a custom fork from Next.js create-next-app
. We've fined tuned it to building applications with our preferred application stack at https://studio206.dev.
You can see the templates we use in ./templates
default
- Standard Bare Bones Next.js App.
- Choose between App / Pages router.
with-sanity
(coming soon)- Choose between App/Pages router
- Generic Sanity Setup
with-sanity-shopify
(coming soon)- Choose between App/Pages router
- Generic Sanity Setup
- Shopify Integration
CLI Options
npx create-206-app --help
Running locally
- Clone the repo:
git clone [email protected]:studio-206/create-206.git
- Install deps:
pnpm i
- To install locally, you can run in the directory root.
npm link
- Now you can run
npx create-206-app
- this is the bin script defined inpackage.json
- Confirm this is installed globally by running
npm ls -g
, you should seecreate-206-app
in the list. - Run
npm/yarn/pnpm run dev
to watch for changes.
Editing templates
When editing a template you may want to test the changes locally. To do this, you can run the following command:
npx create-206-app --branch <branch-with-changes>
This downloads and runs the template from the specified branch, rather than main.
Updating Shared Config.
Shared code that is used across multiple templates is kept in the ./shared
directory, this is if a package or app needs to be copied to multiple templates, see ./shared/tools/copy-eslint-config.ts
for example. It takes eslint-config-studio-206
and copies the directory to each template as the code does not change for these.
- Run
npx ts-node ./shared/tools/copy-eslint-config
to run. - Run
npx ts-node ./shared/tools/copy-prettierrc
to run.
Publishing updates
- Bump the version in the
package.json
. - Run
npm publish
in the root folder (make sure to have all the publishing rights in the studio206 npm org.)