https://github.com/eve-ning/website-svelte

Sanity + Svelte Web App
https://github.com/eve-ning/website-svelte

Last synced: 13 days ago
JSON representation

Sanity + Svelte Web App

• Host: GitHub
• URL: https://github.com/eve-ning/website-svelte
• Owner: Eve-ning
• Created: 2023-12-06T14:07:43.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-17T10:13:17.000Z (5 months ago)
• Last Synced: 2024-12-06T14:03:40.865Z (22 days ago)
• Language: HTML
• Homepage: https://eve-ning.github.io/website-svelte/
• Size: 14.6 MB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# A minimal SvelteKit site with Sanity Studio

This starter uses [SvelteKit](https://kit.svelte.dev/) for the frontend and [Sanity](https://sanity.io/) to handle its content.

## Featuring

- How to fetch content as data from [the Sanity Content Lake](https://www.sanity.io/docs/datastore)

- How to render block content with [Portable Text](https://www.sanity.io/docs/presenting-block-text)

- A [Sanity Studio](https://www.sanity.io/docs/sanity-studio) to create and edit content

- How to crop and render images with [Sanity Image URLs](https://www.sanity.io/docs/image-url)

> **Note**

>

> This starter features an `/app` and a `/studio` folder. The `/app` folder contains the frontend code, and the `/studio` folder contains the Sanity Studio code.

>

> This is **not** a monorepo setup. We put them both in one repository for the sake of simplicity. You might want to have separate repositories for each of the folders, to make it easier to deploy the app and the studio separately.

## Prerequisities

- [Node.js](https://nodejs.org/en/) (v14.18 or later)

- [Sanity CLI](https://www.sanity.io/docs/getting-started-with-sanity-cli) (optional)

## Getting started

The following commands are meant to be run in **both** the `/app` and `/studio` folders.

1. `npm install` to install dependencies

2. `npx -y sanity@latest init --env`, this will:

- ask you to select or create a Sanity project and dataset, use the same Sanity project and dataset in both folders.

- output a `.env` file with appropriate variables

- _(or use `sanity init --env` if you have the CLI installed)_

4. Prefix your environment variables in the SvelteKit `/app` folder with `PUBLIC_`, they should be `PUBLIC_SANITY_DATASET` and `PUBLIC_SANITY_PROJECT_ID`.

3. `npm run dev` to start the development server

Your SvelteKit app should now be running on [http://localhost:5173/](http://localhost:5173/) and Studio on [http://localhost:3333/](http://localhost:3333/).

_Feel free to move each of the folders to their own location and check them into version control._

### Add content

1. Visit the Studio and create and publish a new `Post` document

2. Visit the App and refresh the page to see your content rendered on the page

The schema for the `Post` document is defined in the `/studio/schemas` folder. You can add more documents and schemas to the Studio to suit your needs.

## Removing TypeScript

If you do not wish to use TypeScript, we've included a `remove-typescript.mjs` file in the root of this repository.

To run this file, you must:

1. Run `npm install` in the repository root to install dependencies

2. Run `node remove-typescript.mjs` to strip all types from both the `/app` and `/studio` folders

If you intend to use TypeScript or have stripped TypeScript, you can safely delete all files in the repository root that isn't `/studio` or `/app`.

## Deployments

The `/app` and `/studio` folders are meant to be deployed separately.

Feel free to deploy the App to whichever hosting provider you prefer. We recommend [Vercel](https://vercel.com/).

You can deploy the Sanity Studio by running `sanity deploy` in the `/studio` repository, provided you have the `@sanity/cli` installed globally.