Developing Supabase Docs

Development setup
- Install dependencies
- Fork the repository
Build Supabase
- Running docs
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:

Fork the repository

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

Build Supabase

Clone your GitHub forked repository:

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

Go to the Supabase directory:
```
cd supabase
```

Running docs

We'll be running the Supabase Docs

Build development server

npm
```
npm run build
```
or with yarn
```
yarn build
```
Start development server

npm
```
npm run start
```
or with yarn
```
yarn start
```
Access the local server in your web browser at http://localhost:3010/docs.

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!

2.8 KiB Raw Blame History