# @sanity/server

> Webserver dedicated to serving Sanity, allowing a smooth development experience

Latest version **3.1.4** (published 2023-01-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @sanity/server
pnpm add @sanity/server
yarn add @sanity/server
bun add @sanity/server
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.4 |
| Published | 2023-01-03 |
| First published | 2016-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14.0.0 |
| Dependencies | 13 |
| Unpacked size | 234.5 KB |
| Known vulnerabilities | 0 (+19 in 2 direct dependencies) |
| Install scripts | no |
| Author | Sanity.io |
| Maintainers | svirs, josh_sanity_io, joneidejohnsen, nina.andal, rankers, snorreeb, mattcraig, vincentquigley, stipsan, michael-sanity, rubioz, tonina, ritasdias, simeonsanity, kmelve, bjoerge, rexxars, skogsmaskin, simenss, robinpyon, mariuslundgard, sanity-io, evenw, radhe_sanity, rbotten, vicbergquist, judofyr, obliadp, dcilke, fredcarlsen, jorn_georg, hermanw, mikolajsanity, sgulseth, atombender |
| Keywords | sanity, cms, headless, realtime, content, server, webserver |

## Links

- npm: https://www.npmjs.com/package/@sanity/server
- Repository: https://github.com/sanity-io/sanity
- Homepage: https://www.sanity.io/
- Issues: https://github.com/sanity-io/sanity/issues
- npm.io page: https://npm.io/package/@sanity/server

## Dependencies (13)

- [vite](https://npm.io/package/vite.md) ^3.0.0
- [chalk](https://npm.io/package/chalk.md) ^4.1.2
- [debug](https://npm.io/package/debug.md) ^3.2.7
- [esbuild](https://npm.io/package/esbuild.md) ^0.14.43
- [chokidar](https://npm.io/package/chokidar.md) ^3.5.3
- [read-pkg-up](https://npm.io/package/read-pkg-up.md) ^7.0.1
- [import-fresh](https://npm.io/package/import-fresh.md) ^3.3.0
- [module-alias](https://npm.io/package/module-alias.md) ^2.2.2
- [resolve-from](https://npm.io/package/resolve-from.md) ^5.0.0
- [esbuild-register](https://npm.io/package/esbuild-register.md) ^3.3.2
- [@vitejs/plugin-react](https://npm.io/package/@vitejs/plugin-react.md) ^2.0.0
- [@sanity/generate-help-url](https://npm.io/package/@sanity/generate-help-url.md) ^3.0.0
- [connect-history-api-fallback](https://npm.io/package/connect-history-api-fallback.md) ^1.6.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 3.1.4 (latest) — 2023-01-03
- 2.36.6 (v2) — 2024-11-07
- 2.36.2-weighted-search.16 (weighted-search) — 2023-07-14
- 3.0.0-v3-pte.88 (v3-pte) — 2023-01-16
- 3.0.7-canary.7 (canary) — 2022-12-15
- 3.0.1-findability.164 (findability) — 2022-12-05
- 3.0.0 (dev-preview) — 2022-11-25
- 3.0.0-purple-unicorn.89 (purple-unicorn) — 2022-10-24
- 3.0.0-purple-unicorn-starter.75 (purple-unicorn-starter) — 2022-10-23
- 2.34.3-cdr-ga-4.23 (cdr-ga-4) — 2022-10-20
- 2.34.3-cdr-ga-2.19 (cdr-ga-2) — 2022-10-20
- 2.34.3-cdr-ga.20 (cdr-ga) — 2022-10-20
- 2.34.3-cdr-preview.20 (cdr-preview) — 2022-10-20
- 2.34.2-empty-template-cli.0 (empty-template-cli) — 2022-10-13
- 3.0.0-midnight-pegasus.16 (midnight-pegasus) — 2022-10-11
- … 885 more at https://npm.io/package/@sanity/server/versions

## README

<div align="center">
  <a href="https://sanity.io">
    <img src="https://cdn.sanity.io/images/3do82whm/next/d6cf401d52c33b7a5a354a14ab7de94dea2f0c02-192x192.svg" />
  </a>
  <h1 align="center">Sanity</h1>
  <h4 align="center">
    <a href="https://www.sanity.io/get-started?ref=gh">Get Started</a> |
    <a href="https://www.sanity.io/docs">Docs</a> |
    <a href="https://www.sanity.io">Website</a>
  </h4>
</div>

<div align="center">
  <img alt="" src="https://img.shields.io/npm/v/sanity/latest?style=flat">
  <img alt="" src="https://img.shields.io/npm/v/sanity/next?style=flat">
  <img alt="" src="https://img.shields.io/npm/v/sanity/stable?style=flat">
  <br />
  <img alt="" src="https://img.shields.io/npm/dm/@sanity/client?style=flat">
  <img alt="" src="https://img.shields.io/npm/l/sanity.svg?style=flat">
  <a aria-label="Join the Sanity community" href="https://www.sanity.io/community/join?utm_source=readme">
    <img alt="" src="https://img.shields.io/discord/1304483263171264613?label=Discord"></a>
  <a aria-label="Follow Sanity on Bluesky" href="https://bsky.app/profile/sanity.io">
    <img alt="" src="https://img.shields.io/badge/follow-@sanity.io-blue?logo=bluesky"></a>
</div>

## Build powerful production-ready content workspaces

> The Sanity Composable Content Cloud lets teams create remarkable digital experiences at scale. Sanity Studio is an open-source, single-page application that is fast to set up and quick to configure. The Studio comes with a complete studio customization framework that lets you tailor the workspace as your needs grow.
>
> Sanity hosts your content in a real-time, hosted data store called Content Lake. [Get started](https://www.sanity.io/get-started?ref=gh) with the free plan with generous bandwidth and hosting included and pay-as-you-go for overages.

## Quickstart

Initiate a new project by running the following command:

```bash
npm create sanity@latest

# With other package managers:
yarn create sanity@latest
pnpm create sanity@latest
```

[Go here for a step-by-step guide](https://www.sanity.io/docs/getting-started-with-sanity) on how to get up and running.

Check out [the docs](https://www.sanity.io/docs/sanity-studio) and [plugins](https://www.sanity.io/plugins) and start building.

## Key Features

![Sanity Studio](https://cdn.sanity.io/images/3do82whm/next/0eef48a15688916111a14cae008b0d5bd73865a5-2880x1000.png?w=2000&fit=max&auto=format&dpr=2)

### [Sanity Studio](https://www.sanity.io/studio)

[Sanity Studio](https://www.sanity.io/studio) is an open-source real-time CMS, that you can customize with JavaScript and React.

- Efficient editing, instant UI for complex fields
- Responsive, works on narrow screens
- [Plug-in architecture](https://www.sanity.io/plugins) and [custom components](https://www.sanity.io/docs/component-api)
- [Style with your own branding](https://www.sanity.io/docs/theming)
- [Advanced block editor for structured content](https://www.sanity.io/docs/block-content)
- Use JavaScript to add [field validations](https://www.sanity.io/docs/validation), [organize documents](https://www.sanity.io/docs/overview-structure-builder), and set [initial values](https://www.sanity.io/docs/theming)

### [Developer experience](https://www.sanity.io/developer-experience)

- [Bring your own frontend, or whatever else you might need](https://www.sanity.io/docs/build-with-sanity).
- [Sweet APIs for reading, writing, importing, exporting, go back in time, and listening for updates](https://www.sanity.io/docs/datastore).
- [Secure, scalable and GDPR compliant](https://www.sanity.io/security).
- [Zero config Graph Oriented Query Language (GROQ)](https://www.sanity.io/docs/how-queries-work), and [GraphQL API](https://www.sanity.io/docs/graphql).
- [Helpful and friendly developer community](https://snty.link/community).

### [Structured Content](https://www.sanity.io/structured-content)

- Distribute from a single source of truth, in real-time.
- Unlock programmatic approaches to workflows and design.
- [Upload images and transform them on demand](https://www.sanity.io/docs/asset-pipeline).
- Query images for metadata like dominant colors, sizes, geo-location, and EXIF metadata.
- [Rich text that can be serialized into any markup language](https://www.sanity.io/guides/introduction-to-portable-text).

## Stay up to date

- Follow us on [X](https://x.com/sanity_io)
- Follow us on [Bluesky](https://bsky.app/profile/sanity.io)
- Subscribe to our [YouTube channel](https://www.youtube.com/@sanity_io)
- Subscribe to [our blog by RSS](https://www.sanity.io/feed/rss)
- Subscribe to our [newsletter](https://www.sanity.io/newsletter)
- Join the [Sanity community](https://www.sanity.io/community/join?utm_source=readme)

## Code of Conduct

We aim to be an inclusive, welcoming community for everyone. To make that explicit, we have a [code of conduct](https://github.com/sanity-io/sanity/blob/main/CODE_OF_CONDUCT.md) that applies to communication around the project.

## Want to contribute?

Found a bug, or want to contribute code? Pull requests and issues are most welcome. Read our [contributing guidelines](https://github.com/sanity-io/sanity/blob/main/CONTRIBUTING.md) to learn how.

### Help Improve Sanity Studio translations

We're always looking to make Sanity Studio more accessible and user-friendly, and your contributions can make a big difference. Whether you're a seasoned developer or just starting out, helping with translations is a fantastic way to get involved.

If you're fluent in a language other than English, we'd love your help in reviewing and improving translations. Your expertise can greatly enhance the experience for users worldwide.

How to Contribute:

1. Visit our [sanity-io/locales](https://github.com/sanity-io/locales) repository and try out a locale you are fluent in.
2. Have ideas for improvements? Submit a PR following the [contributing guide](https://github.com/sanity-io/locales/blob/main/CONTRIBUTING.md#getting-started).
3. See if there are open PRs in languages you are fluent in and help review them.

Interested in playing a bigger role? You can ask to be added as a maintainer to oversee translations for specific languages, where you will be automatically added as a reviewer on PRs that involve your language. See the [sanity-io/locales README](https://github.com/sanity-io/locales#readme) for more.

Your contributions not only improve Sanity Studio but also bring together a diverse and global community of users. We appreciate every effort, big or small, and we can't wait to see what you bring to the table!

## License

Sanity Studio is available under the [_MIT License_](https://github.com/sanity-io/sanity/blob/main/LICENSE)

---
_Source: https://npm.io/package/@sanity/server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
