feat: indicate in metadata that the quickstart option was used in pro…

…ject creation (#6065) * feat: indicate in metadata that the quickstart option was used in project creation * add quickstart template directory * feat: use quickstart template * Update packages/@sanity/cli/templates/quickstart/README.md Co-authored-by: Jon Eide Johnsen <[email protected]> * Update packages/@sanity/cli/templates/quickstart/README.md Co-authored-by: Jon Eide Johnsen <[email protected]> * update selectProjectTemplate comment --------- Co-authored-by: RostiMelk <[email protected]> Co-authored-by: Jon Eide Johnsen <[email protected]>
sanity-io · Mar 26, 2024 · 468e76c · 468e76c
1 parent 97c0b0c
commit 468e76c
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 2 deletions.
diff --git a/packages/@sanity/cli/src/actions/init-project/initProject.ts b/packages/@sanity/cli/src/actions/init-project/initProject.ts
@@ -964,9 +964,8 @@ export default async function initSanity(
 
   function selectProjectTemplate() {
     // Make sure the --quickstart and --template are not used together
-    // Force template to clean if --quickstart is used
     if (flags.quickstart) {
-      return 'clean'
+      return 'quickstart'
     }
 
     const defaultTemplate = unattended || flags.template ? flags.template || 'clean' : null

diff --git a/packages/@sanity/cli/src/actions/init-project/templates/index.ts b/packages/@sanity/cli/src/actions/init-project/templates/index.ts
@@ -3,6 +3,7 @@ import blog from './blog'
 import clean from './clean'
 import getStartedTemplate from './getStarted'
 import moviedb from './moviedb'
+import quickstart from './quickstart'
 import shopify from './shopify'
 import shopifyOnline from './shopifyOnline'
 
@@ -13,6 +14,7 @@ const templates: Record<string, ProjectTemplate | undefined> = {
   moviedb,
   shopify,
   'shopify-online-storefront': shopifyOnline,
+  quickstart, // empty project that dynamically imports its own schema
 }
 
 export default templates
diff --git a/packages/@sanity/cli/src/actions/init-project/templates/quickstart.ts b/packages/@sanity/cli/src/actions/init-project/templates/quickstart.ts
@@ -0,0 +1,5 @@
+import {type ProjectTemplate} from '../initProject'
+
+const quickStartTemplate: ProjectTemplate = {}
+
+export default quickStartTemplate
diff --git a/packages/@sanity/cli/templates/quickstart/README.md b/packages/@sanity/cli/templates/quickstart/README.md
@@ -0,0 +1,9 @@
+# Sanity Studio
+
+Congratulations, you have now installed Sanity Studio, an open source real-time content editing environment connected to the Sanity Content Lake backend.
+
+Now you can do the following things:
+
+- [Read “getting started” in the docs](https://www.sanity.io/docs/introduction/getting-started?utm_source=readme)
+- [Join the community Slack](https://slack.sanity.io/?utm_source=readme)
+- [Extend and build plugins](https://www.sanity.io/docs/content-studio/extending?utm_source=readme)
diff --git a/packages/@sanity/cli/templates/quickstart/schemaTypes/index.js b/packages/@sanity/cli/templates/quickstart/schemaTypes/index.js
@@ -0,0 +1 @@
+export const schemaTypes = []
diff --git a/packages/@sanity/cli/templates/quickstart/static/.gitkeep b/packages/@sanity/cli/templates/quickstart/static/.gitkeep
@@ -0,0 +1 @@
+Files placed here will be served by the Sanity server under the `/static`-prefix
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Files placed here will be served by the Sanity server under the `/static`-prefix