Getting started

Visit https://docs.surrealdb.com/docs/introduction/start to get started with SurrealDB.

Contributing

Please see our contributing.md.

Good First Issues

We have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

Installation

$ pnpm install

Local Development

$ pnpm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ pnpm build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true pnpm deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> pnpm deploy