From c83a66cc4c62fa7a984bdc741e73ecb9dcd7c817 Mon Sep 17 00:00:00 2001 From: Isaiah Hamilton <70828596+Isaiah-Hamilton@users.noreply.github.com> Date: Sun, 28 Nov 2021 22:34:32 -0500 Subject: [PATCH] Update local development docs (#4098) * Update DEVELOPERS.md * Update DEVELOPERS.md * Change supabase.io to supabase.com * Change app.supabase.com to app.supabase.io --- DEVELOPERS.md | 72 +++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 64 insertions(+), 8 deletions(-) diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 93f69172730..cccc757e1ce 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -40,16 +40,20 @@ To build Supabase, you clone the source code repository: ### Choosing Directory -Before you start a development server, you must choose if you want to work on the [Supabase website](https://supabase.io) or [Supabase Docs](https://supabase.io/docs/). +Before you start a development server, you must choose if you want to work on the [Supabase Website](https://supabase.com), [Supabase Docs](https://supabase.com/docs/), or [Supabase Studio](https://app.supabase.io). -1. Go to the supabase.io directory +1. Go to the [Supabase Website](https://supabase.com) directory ```sh cd www ``` - or Go to the [Supabase Docs](https://supabase.io/docs/) directory + Go to the [Supabase Docs](https://supabase.com/docs/) directory ```sh cd web ``` + Go to the [Supabase Studio](https://app.supabase.io) directory + ```sh + cd studio + ``` 2. Install npm dependencies: @@ -65,13 +69,19 @@ Before you start a development server, you must choose if you want to work on th ## Start a Development Server -To debug code, and to see changes in real time, it is often useful to have a local HTTP 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-Website-Development-Server) +- [Supabase Docs](###Supabase-Docs-Development-Server) +- [Supabase Studio](###Supabase-Studio-Development-Server) + +### Supabase Website Development Server 1. Start development server npm ```sh - npm run start + npm run dev ``` or with yarn @@ -81,12 +91,58 @@ To debug code, and to see changes in real time, it is often useful to have a loc 2. To access the local server, enter the following URL into your web browser: - [Supabase website](https://supabase.io) ```sh - http://localhost:3000 + http://localhost:3000/ ``` - [Supabase Docs](https://supabase.io/docs/) +### Supabase Docs Development Server + +1. Build development server + + npm + ```sh + npm run build + ``` + + or with yarn + ```sh + yarn build + ``` + +2. Start development server + + npm + ```sh + npm run start + ``` + + or with yarn + ```sh + yarn start + ``` + +3. To access the local server, enter the following URL into your web browser: + ```sh http://localhost:3005/docs ``` + +### Supabase Studio Development Server + +1. Start development server + + npm + ```sh + npm run dev + ``` + + or with yarn + ```sh + yarn dev + ``` + +2. To access the local server, enter the following URL into your web browser: + + ```sh + http://localhost:8082/ + ```