DEVELOPERS.md

Developing Supabase

• Development Setup
• Installing Dependencies
• Building Supabase
• Start a Development Server
• Finally
• Community Channels

Development Setup

First off, thanks for your interest in Supabase and for wanting to contribute! before you begin, read the code of conduct and check out the existing issues. This document describes how to set up your development environment to build and test Supabase.

Installing Dependencies

Before you can build Supabase, you must install and configure the following dependencies on your machine:

• Git

• Node.js v16.x (LTS)

• npm or yarn

Forking Supabase on GitHub

To contribute code to Supabase, you must fork the Supabase Repository. After you fork the repository, you may now begin editing the source code.

Building Supabase

To build Supabase, you clone the source code repository:

2. Clone your GitHub forked repository:

   git clone https://github.com/<github_username>/supabase.git

3. Go to the Supabase directory:

   cd supabase

Choosing Directory

Before you start a development server, you must choose if you want to work on the Supabase Website, Supabase Docs, or Supabase Studio.

1. Go to the Supabase Website directory

   cd www

   Go to the Supabase Docs directory

   cd web

   Go to the Supabase Studio directory

   cd studio

2. Install npm dependencies:

   npm

   npm install

   or with yarn

   yarn install

Start a Development Server

To debug code, and to see changes in real time, it is often useful to have a local HTTP server. Click one of the three links below to choose which development server you want to start.

• Supabase Website
• Supabase Docs
• Supabase Studio

Supabase Website Development Server

1. Start development server

   npm

   npm run dev

   or with yarn

   yarn dev

2. To access the local server, enter the following URL into your web browser:

   http://localhost:3000/

Supabase Docs Development Server

1. Build development server

   npm

   npm run build

   or with yarn

   yarn build

2. Start development server

   npm

   npm run start

   or with yarn

   yarn start

3. To access the local server, enter the following URL into your web browser:

   http://localhost:3005/docs

Supabase Studio Development Server

1. Start development server

   npm

   npm run dev

   or with yarn

   yarn dev

2. To access the local server, enter the following URL into your web browser:

   http://localhost:8082/

For more information on Supabase Studio, see the Supabase Studio readme.

Finally

After making your changes to the file(s) you'd like to update, it's time to open a pull request. Once you submit your pull request, others from the Supabase team/community will review it with you.

Did you have an issue, like a merge conflict, or don't know how to open a pull request? Check out GitHub's pull request tutorial on how to resolve merge conflicts and other issues. Once your PR has been merged, you will be proudly listed as a contributor in the contributor chart

Community Channels

Stuck somewhere? Have any questions? please join the Discord Community Server or the Github Discussions. We are here to help!