vaporvee/template-sanity
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Yannik
2025-08-31 15:15:07 +00:00
parent a234b2c210
commit 57b8ff3cb7
1 changed files with 13 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -1,12 +1,12 @@
# ✨ Lumify Sanity Template # ✨ Sanity Template
Official CLI and starter template for building modern web apps with Sveltekit, Sanity, Bun, and Shadcn UI — bundled into a single monorepo. CLI and starter template for building modern web apps with Sveltekit, Sanity, Bun, and Shadcn UI — bundled into a single monorepo.
--- ---
## 📦 What It Does ## 📦 What It Does
The `@lumify-systems/template-sanity` CLI sets up a fully functional monorepo with: The `@vaporvee/template-sanity` CLI sets up a fully functional monorepo with:
* ⚡ **Sveltekit** for the frontend * ⚡ **Sveltekit** for the frontend
* 📝 **Sanity Studio** CMS with custom schemas * 📝 **Sanity Studio** CMS with custom schemas
@@ -18,18 +18,18 @@ The `@lumify-systems/template-sanity` CLI sets up a fully functional monorepo wi
## 🚀 How to Use ## 🚀 How to Use
### Setup GitHub private NPM registry ### Setup vaporvee git private NPM registry
Create a file called `.npmrc` in your home directory with the following content: Create a file called `.npmrc` in your home directory with the following content:
``` ```
@lumify-systems:registry=https://npm.pkg.github.com/ @vaporvee:registry=https://git.vaporvee.com/api/packages/testuser/npm/
//npm.pkg.github.com/:_authToken=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 //git.vaporvee.com/api/packages/testuser/npm/:_authToken=<YOUR_TOKEN>
``` ```
You can now scaffold a new project using the CLI: You can now scaffold a new project using the CLI:
```bash ```bash
bunx @lumify-systems/template-sanity bunx @vaporvee/template-sanity
``` ```
Then follow the interactive prompts: Then follow the interactive prompts:
@@ -73,23 +73,15 @@ bun run deploy # Deploy the Sanity Studio
## 🧩 Shadcn UI ## 🧩 Shadcn UI
Shadcn UI is pre-installed and configured in `client`  Shadcn UI is pre-installed and configured in `client`
To add components run the following inside the client folder: To add components run the following inside the client folder:
```bash ```bash
bunx shadcn-ui@latest add [component] bunx shadcn-svelte@latest add [component]
``` ```
🔗 [shadcn-svelte.com/](https://shadcn-svelte.com/)
🔗 [ui.shadcn.dev](https://ui.shadcn.dev/docs/components) 🔗 [animation-svelte.vercel.app](https://animation-svelte.vercel.app/) (without cli)
🔗 [shadcnui-blocks.com](http://www.shadcnui-blocks.com)
🔗 [kokonutui.com](https://kokonutui.com)
🔗 [ui.aceternity.com](https://ui.aceternity.com)
🔗 [21st.dev](https://21st.dev)
--- ---
@@ -97,8 +89,8 @@ bunx shadcn-ui@latest add [component]
Customize your Studio or learn more about Sanity at: Customize your Studio or learn more about Sanity at:
📘 [sanity.io/docs](https://www.sanity.io/docs) 📘 [shadcn-svelte.com/docs](https://shadcn-svelte.com/docs)
--- ---
Happy building with Lumify! 🚀 Happy building! 🚀