dima/supabase
1
0 Fork 0
mirror of https://github.com/supabase/supabase.git synced 2026-10-05 09:25:06 +03:00
Code Issues Packages Projects Releases Wiki Activity

update(DEVELOPERS.md): improved docs for getting-started and added what's next section

Browse Source
This commit is contained in:
Yeganathan S committed 2022-01-29 20:58:00 +05:30
1 parent 178d7063d4
commit 40902cdc93
1 file changed
+33 -12
Download Patch File Download Diff File Expand all files Collapse all files
DEVELOPERS.md
+33 -12
View File
@@ -1,13 +1,18 @@
# Developing Supabase
* [Development Setup](#Development-Setup)
* [Installing Dependencies](#Installing-Dependencies)
* [Building Supabase](#Building-Supabase)
* [Start a Development Server](#Start-a-Development-Server)
* [Build in Public](#Build-in-Public)
* [Development Setup](##Development-Setup)
* [Installing Dependencies](###Installing-Dependencies)
* [Building Supabase](##Building-Supabase)
* [Start a Development Server](##Start-a-Development-Server)
* [What's Next?](##What's-Next)
* [Community Channels](##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](https://github.com/supabase/.github/blob/main/CODE_OF_CONDUCT.md) and check out the [existing issues](https://github.com/supabase/supabase/issues).
This document describes how to set up your development environment to build and test Supabase.
### Installing Dependencies
@@ -72,9 +77,9 @@ Before you start a development server, you must choose if you want to work on th
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-Website-Development-Server)
- [Supabase Docs](#Supabase-Docs-Development-Server)
- [Supabase Studio](#Supabase-Studio-Development-Server)
- [Supabase Website](###Supabase-Website-Development-Server)
- [Supabase Docs](###Supabase-Docs-Development-Server)
- [Supabase Studio](###Supabase-Studio-Development-Server)
### Supabase Website Development Server
@@ -148,10 +153,26 @@ To debug code, and to see changes in real time, it is often useful to have a loc
http://localhost:8082/
```
For more information on Supabase Studio, see the [Supabase Studio readme](./studio/README.md).
## What's Next?
## Build in Public
Make your changes to the file(s) you'd like to update.
Videos of building supabase made in public.
### Open a pull request
- [Contributing to open source as a beginner - Supabase](https://youtu.be/OAqhsylUuWg) - [@imskr](https://github.com/imskr)
When you're done making changes and you'd like to propose them for review by opening a pull request.
### Submit your PR & get it reviewed
- Once you submit your PR, others from the Unleash community will review it with you. The first thing you're going to want to do is a self review.
- After that, we may have questions, check back on your PR to keep up with the conversation.
- Did you have an issue, like a merge conflict? Check out GitHub's git tutorial on how to resolve merge conflicts and other issues.
### Your PR is merged!
Congratulations! The whole Supabase community thanks you 🙏🏼
Once your PR is merged, you will be proudly listed as a contributor in the [contributor chart](https://github.com/supabase/supabase/graphs/contributors).
## Community Channels
Stuck somewhere? Have any questions? please join the [Discord Community Server](https://discord.supabase.com/) or the [Github Discussions](https://discord.supabase.com/). We are here to help!