Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

chore: small onboarding docs/DX updates (#47719)

kanad1ce1fd66643c
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b5d3188a5b3..d8eba6749be 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -2,10 +2,6 @@
Thank you for contributing to Supabase! We’re a big, exciting open source project and we’d love to have you contribute! Here’s some resources and guidance to help you get started:
-[1. Getting Started](#getting-started)
-[2. Issues](#issues)
-[3. Pull Requests](#pull-requests)
-
## Getting Started
To ensure a positive and inclusive environment, please read our [code of conduct](https://github.com/supabase/.github/blob/main/CODE_OF_CONDUCT.md) before contributing. For help setting up the code in this repo, please follow our [DEVELOPERS.md](https://github.com/supabase/supabase/blob/master/DEVELOPERS.md) file. For the [docs](https://supabase.com/docs) site, follow this [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/apps/docs/CONTRIBUTING.md) guide.
diff --git a/DEVELOPERS.md b/DEVELOPERS.md
index 6bf8f3c41db..4705acedb3b 100644
--- a/DEVELOPERS.md
+++ b/DEVELOPERS.md
@@ -1,7 +1,6 @@
# Developing Supabase
- [Developing Supabase](#developing-supabase)
-
- [Getting started](#getting-started)
- [Install dependencies](#install-dependencies)
- [Local development](#local-development)
@@ -34,11 +33,11 @@ To ensure a positive and inclusive environment, please read our [code of conduct
You will need to install and configure the following dependencies on your machine to build [Supabase](https://supabase.com):
-- [Git](https://git-scm.com/)
-- [Node.js](https://nodejs.org) version as documented in [.nvmrc](./.nvmrc)
-- [pnpm](https://pnpm.io/) version 9.x.x or higher
-- [make](https://www.gnu.org/software/make/) or the equivalent to `build-essentials` for your OS
-- [Docker](https://docs.docker.com/get-docker/) (to run studio locally)
+- [**Git**](https://git-scm.com/)
+- [**Node.js**](https://nodejs.org) (version as documented in [`.nvmrc`](./.nvmrc))
+- [**pnpm**](https://pnpm.io/) (version as documented in the `packageManager` field in [`package.json`](./package.json))
+- [**make**](https://www.gnu.org/software/make/) (or the equivalent to `build-essentials` for your OS)
+- [**Docker**](https://docs.docker.com/get-docker/) (to run studio locally)
## Local development
@@ -120,7 +119,6 @@ For example:
1. `cd apps/studio`: move to the `studio` workspace.
2. `pnpm add react`: installs `react` into `studio` workspace.
-
---
## Running Docker for Supabase Studio
diff --git a/mise.toml b/mise.toml
new file mode 100644
index 00000000000..6a7e1ac3155
--- /dev/null
+++ b/mise.toml
@@ -0,0 +1,2 @@
+[settings]
+idiomatic_version_file_enable_tools = ["node", "pnpm"]