supabase/apps/reference/DEVELOPERS.md

Developing Supabase Docs

1. Development setup
   • Install dependencies
   • Fork the repository
2. Build Supabase
   • Run the docs locally
   • Editing files
3. Create a pull request

• Monorepo
• Community channels

Development setup

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.

Install dependencies

You need to install and configure the following dependencies on your machine to build Supabase:

• Git
• Node.js v16.x (LTS)
• npm version 7+ or Yarn

Fork the repository

To contribute code to Supabase, you must fork the Supabase Repository.

Build Supabase

1. Clone your GitHub forked repository:

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

2. Go to the Supabase directory:

   cd supabase
   

Run the docs locally

1. Build the development server

   npm

   npm run build
   

   or with yarn

   yarn build
   

2. Start the development server

   npm

   npm run start
   

   or with yarn

   yarn start
   

3. Access the local server in your web browser at http://localhost:3010/docs.

---

Editing files

Our docs site are comprised of guides, tutorials, quickstarts, and reference docs. Note that the reference docs are generated from spec files.

If you go to any page in the Supabase docs, you'll see an Edit this page link at the bottom. This link indicates which file you need to edit.

For example, the NextJS Quickstart is a markdown file you can edit directly. However, this signUp() reference doc is generated from a spec file.

Create a pull request

After making your changes, open a pull request (PR). 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.

---

Monorepo

We are in the process of migrating this repository to monorepo, using Turborepo. This app is currently not in that workflow, but if you want to contribute to any of the other apps, please refer to the developers readme.

---

Community channels

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