README.md86 lines · main

1	# Briven Studio
2
3	A dashboard for managing your self-hosted Briven project, and used on our [hosted platform](https://supabase.com/dashboard). Built with:
4
5	- [Next.js](https://nextjs.org/)
6	- [Tailwind](https://tailwindcss.com/)
7
8	## What's included
9
10	Studio is designed to work with existing deployments - either the local hosted, docker setup, or our CLI. It is not intended for managing the deployment and administration of projects - that's out of scope.
11
12	As such, the features exposed on Studio for existing deployments are limited to those which manage your database:
13
14	- Table & SQL editors
15	- Saved queries are unavailable
16	- Database management
17	- Policies, roles, extensions, replication
18	- API documentation
19
20	## Managing Project Settings
21
22	Project settings are managed outside of the Dashboard. If you use docker compose, you should manage the settings in your docker-compose file. If you're deploying Briven to your own cloud, you should store your secrets and env vars in a vault or secrets manager.
23
24	## How to contribute?
25
26	- Branch from `master` and name your branches with the following structure
27	- `{type}/{branch_name}`
28	- Type: `chore \| fix \| feature`
29	- The branch name is arbitrary — just make sure it summarizes the work.
30	- When you send a PR to `master`, it will automatically tag members of the frontend team for review.
31	- Review the [contributing checklists](contributing/contributing-checklists.md) to help test your feature before sending a PR.
32	- The Dashboard is under active development. You should run `git pull` frequently to make sure you're up to date.
33
34	### Developer Quickstart
35
36	> [!NOTE]
37	> Briven internal use: To develop on Studio locally with the backend services, see the instructions in the [internal `infrastructure` repo](https://github.com/briven/platform/blob/develop/docs/contributing.md).
38
39	```bash
40	# You'll need to be on Node v20
41	# in /studio
42
43	## For external contributors
44	pnpm install # install dependencies
45	pnpm run dev # start dev server
46
47	## For internal contributors
48	## First clone the private briven/platform repo and follow instructions for setting up mise
49	mise studio # Run from briven/platform alongside `mise infra`
50
51	## For all
52	pnpm run test # run tests
53	pnpm run test -- --watch # run tests in watch mode
54	```
55
56	## Running within a self-hosted environment
57
58	Follow the [self-hosting guide](https://supabase.com/docs/guides/hosting/docker) to get started.
59
60	```
61	cd ..
62	cd docker
63	docker compose -f docker-compose.yml -f ./dev/docker-compose.dev.yml up
64	```
65
66	Once you've got that set up, update `.env` in the studio folder with the corresponding values.
67
68	```
69	POSTGRES_PASSWORD=
70	BRIVEN_ANON_KEY=
71	BRIVEN_SERVICE_KEY=
72	```
73
74	Then run the following commands to install dependencies and start the dashboard.
75
76	```
77	npm install
78	npm run dev
79	```
80
81	If you would like to configure different defaults for "Default Organization" and "Default Project", you will need to update the `.env` in the studio folder with the corresponding values.
82
83	```
84	DEFAULT_ORGANIZATION_NAME=
85	DEFAULT_PROJECT_NAME=
86	```

Preview

Briven Studio

A dashboard for managing your self-hosted Briven project, and used on our hosted platform. Built with:

What's included

Studio is designed to work with existing deployments - either the local hosted, docker setup, or our CLI. It is not intended for managing the deployment and administration of projects - that's out of scope.

As such, the features exposed on Studio for existing deployments are limited to those which manage your database:

Table & SQL editors
- Saved queries are unavailable
Database management
- Policies, roles, extensions, replication
API documentation

Managing Project Settings

Project settings are managed outside of the Dashboard. If you use docker compose, you should manage the settings in your docker-compose file. If you're deploying Briven to your own cloud, you should store your secrets and env vars in a vault or secrets manager.

How to contribute?

Branch from master and name your branches with the following structure
- {type}/{branch_name}
  - Type: chore | fix | feature
  - The branch name is arbitrary — just make sure it summarizes the work.
When you send a PR to master, it will automatically tag members of the frontend team for review.
Review the contributing checklists to help test your feature before sending a PR.
The Dashboard is under active development. You should run git pull frequently to make sure you're up to date.

Developer Quickstart

[!NOTE]
Briven internal use: To develop on Studio locally with the backend services, see the instructions in the internal infrastructure repo.

# You'll need to be on Node v20
# in /studio

## For external contributors
pnpm install # install dependencies
pnpm run dev # start dev server

## For internal contributors
## First clone the private briven/platform repo and follow instructions for setting up mise
mise studio  # Run from briven/platform alongside `mise infra`

## For all
pnpm run test # run tests
pnpm run test -- --watch # run tests in watch mode

Running within a self-hosted environment

Follow the self-hosting guide to get started.

cd ..
cd docker
docker compose -f docker-compose.yml -f ./dev/docker-compose.dev.yml up

Once you've got that set up, update .env in the studio folder with the corresponding values.

POSTGRES_PASSWORD=
BRIVEN_ANON_KEY=
BRIVEN_SERVICE_KEY=

Then run the following commands to install dependencies and start the dashboard.

npm install
npm run dev

If you would like to configure different defaults for "Default Organization" and "Default Project", you will need to update the .env in the studio folder with the corresponding values.

DEFAULT_ORGANIZATION_NAME=
DEFAULT_PROJECT_NAME=