diff --git a/DEVELOPERS.md b/DEVELOPERS.md index 51198bd2988..51a2bf03047 100644 --- a/DEVELOPERS.md +++ b/DEVELOPERS.md @@ -1,5 +1,6 @@ # Developing Supabase +## Table of Contents * [Development Setup](##Development-Setup) * [Installing Dependencies](###Installing-Dependencies) * [Building Supabase](##Building-Supabase) @@ -71,6 +72,7 @@ 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. +### Table of Contents - [Supabase Website](###Supabase-Website-Development-Server) - [Supabase Docs](###Supabase-Docs-Development-Server) - [Supabase Studio](###Supabase-Studio-Development-Server) diff --git a/www/README.md b/www/README.md index b1995179943..14ff072e6fc 100644 --- a/www/README.md +++ b/www/README.md @@ -6,23 +6,21 @@ This is a single repository for two different websites. Our documents were creat Install the [Vercel CLI](https://vercel.com/cli). -You will need to run the marketing website and docs website separately. +You will need to run the marketing website and docs website separately. To learn how to run both websites, see the [Development Guide](../DEVELOPERS.md) for more information. -``` -# tab 1 -make dev +```sh +# cd into the supabase directory +cd supabase -# tab 2 +# cd into the www directory cd www + +# install and run the website npm install npm run dev -# tab 3 -cd web/spec -make -npm install -npm run gen:supabase -npm run start +# visit the website +http://localhost:3000 ``` In production, this setup is deployed as two different vercel websites (`docs` and `www`) @@ -31,6 +29,3 @@ In production, this setup is deployed as two different vercel websites (`docs` a - Referencing resources in nested folders may not work for `web` (eg `/web/static/folder/nestedfolder/asset`) may not work. - Possibly need to prepend all images/assets in docs site with baseUrl. - - -