Skip to content

Commit 1b78b3e

Browse files
authored
Merge pull request #3 from dnunez02/patch-1
Updated local setup documentation for Docker and Supabase
2 parents b5875fc + 4799006 commit 1b78b3e

File tree

1 file changed

+38
-8
lines changed

1 file changed

+38
-8
lines changed

docs/developers/local-setup.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Before starting, ensure you have the following installed:
1414
| Requirement | Version | Notes |
1515
|-------------|---------|-------|
1616
| Node.js | v22 (recommended) | Use [nvm](https://github.com/nvm-sh/nvm) for version management |
17-
| Docker | Latest | Required for local Supabase |
17+
| Docker | Latest | Required for local Supabase. Can use [Docker desktop](https://www.docker.com/products/docker-desktop/) to quickly setup a docker daemon for development. |
1818
| Git | Latest | For cloning the repository |
1919

2020
## Quick Start (Staging Backend)
@@ -92,25 +92,55 @@ For development requiring database changes, RLS policy modifications, or running
9292
4. **Configure environment variables**
9393

9494
After `supabase start`, you'll see output like:
95-
```
96-
API URL: http://127.0.0.1:54321
97-
anon key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
98-
service_role key: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
99-
```
95+
96+
```bash
97+
supabase local development setup is running.
98+
99+
╭──────────────────────────────────────╮
100+
│ 🔧 Development Tools │
101+
├─────────┬────────────────────────────┤
102+
│ Studio │ http://127.0.0.1:54323 │
103+
│ Mailpit │ http://127.0.0.1:54324 │
104+
│ MCP │ http://127.0.0.1:54321/mcp │
105+
╰─────────┴────────────────────────────╯
106+
107+
╭─────────────────────────────────────────────────╮
108+
│ 🌐 APIs │
109+
├─────────────┬───────────────────────────────────┤
110+
│ Project URL │ http://127.0.0.1:54321 │
111+
│ REST │ http://127.0.0.1:54321/rest/v1 │
112+
│ GraphQL │ http://127.0.0.1:54321/graphql/v1 │
113+
╰─────────────┴───────────────────────────────────╯
114+
115+
╭───────────────────────────────────────────────────────────────╮
116+
│ ⛁ Database │
117+
├─────┬─────────────────────────────────────────────────────────┤
118+
│ URL │ postgresql://postgres:postgres@127.0.0.1:54322/postgres │
119+
╰─────┴─────────────────────────────────────────────────────────╯
120+
121+
╭──────────────────────────────────────────────────────────────╮
122+
│ 🔑 Authentication Keys │
123+
├─────────────┬────────────────────────────────────────────────┤
124+
│ Publishable │ sb_publishable_... │
125+
│ Secret │ sb_secret_... │
126+
╰─────────────┴────────────────────────────────────────────────╯
127+
128+
```
100129

101130
Update your `.env.local`:
102131
```bash
103132
SUPABASE_URL=http://127.0.0.1:54321
104133
NEXT_PUBLIC_SUPABASE_URL=http://127.0.0.1:54321
105-
NEXT_PUBLIC_SUPABASE_ANON_KEY=<anon key from output>
106-
SUPABASE_SERVICE_ROLE_KEY=<service_role key from output>
134+
NEXT_PUBLIC_SUPABASE_ANON_KEY=<publishable key from output>
135+
SUPABASE_SERVICE_ROLE_KEY=<secret key from output>
107136
ENABLE_SIGNUPS=true
108137
```
109138

110139
:::warning
111140
Never expose `SUPABASE_SERVICE_ROLE_KEY` to the browser or commit it to version control. Keep it in server-only code and CI secrets.
112141
:::
113142

143+
114144
5. **Build the application**
115145
```bash
116146
npm run build

0 commit comments

Comments
 (0)