GitHub - authzed/playground: Playground for SpiceDB, the open source, Google Zanzibar-inspired permissions database to enable fine-grained access control for customer applications (original) (raw)

Playground

The SpiceDB Playground is an interactive app for building a SpiceDB schema, interacting with test relationships, and quickly iterating with test assertions.

Whether you're just getting started learning SpiceDB concepts or need to develop a new permissions system schema for your application, the SpiceDB playground has functionality to help.

Features include:

Rich text editor with syntax highlighting and tooltips
Visual relationship editor with support for defining caveat context data
Developer system that detects and presents schema and data errors
Real-time check requests against a full SpiceDB instance running client side via WASM
Fully functional zed CLI instance running client side via WASM
Schema and relationship graph visualization
Import and export schema and workspace data as a YAML file

What is SpiceDB?

SpiceDB is a graph database purpose-built for storing and evaluating access control data.

As of 2021, broken access control became the #1 threat to the web. With SpiceDB, developers finally have the solution to stopping this threat the same way as the hyperscalers.

Getting Started

Run locally

yarn add global serve && yarn build && cd build && serve

Deploying

Docker

Run the latest Docker container

docker run -it -p 3000:3000 ghcr.io/authzed/spicedb-playground:latest

Connect to the running container.

Vercel

Deploy an instance hosted on Vercel

or using the Vercel CLI

vercel build vercel deploy --prebuilt

ℹ️ Git Large File Storage (LFS) must be enabled in your Vercel project settings.

To enable the sharing functionality on Vercel, you need to configure the following environment variables in your Vercel project settings:

Required for sharing:

S3_ENDPOINT - Your S3-compatible storage endpoint (e.g., https://s3.amazonaws.com for AWS S3)
S3_BUCKET - Name of the S3 bucket to store shared playground data
SHARE_SALT - A random string used for generating share hashes (keep this secret)
AWS_ACCESS_KEY_ID - AWS access key for S3 access
AWS_SECRET_ACCESS_KEY - AWS secret key for S3 access
VITE_SHARE_API_ENDPOINT - The URL of your deployed Vercel instance (e.g., https://your-playground.vercel.app)

Optional:

VITE_GOOGLE_ANALYTICS_MEASUREMENT_ID - Google Analytics measurement ID
VITE_DISCORD_CHANNEL_ID - Discord channel ID for embedded chat
VITE_DISCORD_SERVER_ID - Discord server ID
VITE_DISCORD_INVITE_URL - Discord invite URL (defaults to https://authzed.com/discord)

You can set these environment variables in the Vercel dashboard under your project's Settings > Environment Variables.

The vercel CLI can be used to run locally with sharing enabled:

VITE_SHARE_API_ENDPOINT=http://localhost:3000 SHARE_SALT=... AWS_ACCESS_KEY_ID=... AWS_SECRET_ACCESS_KEY=... S3_ENDPOINT=... S3_BUCKET=...  vercel dev

Developing your own schema

You can try both SpiceDB and zed entirely in your browser on a SpiceDB Playground deployment thanks to the power of WebAssembly.

If you don't want to start with the examples loadable from a Playground, you can follow a guide for developing a schema or review the the schema language design documentation.

Watch the SpiceDB primer video to get started with schema development:

Contribute

CONTRIBUTING.md documents communication, contribution flow, legal requirements, and common tasks when contributing to the project.

You can find issues by priority: Urgent, High, Medium, Low, Maybe. There are also good first issues.

Our documentation website is also open source if you'd like to clarify anything you find confusing.

Joining the SpiceDB Community

SpiceDB is a community project where everyone is invited to participate and feel welcomed. While the project has a technical goal, participation is not restricted to those with code contributions. Join our Community Discord to ask questions and meet other users.