Skip to content

Latest commit

 

History

History
148 lines (104 loc) · 3.07 KB

DEVELOPERS.md

File metadata and controls

148 lines (104 loc) · 3.07 KB
Raw

Developing Supabase

Development Setup

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:

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:

  1. Clone your Github forked repository:

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

  2. 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 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/