Skip to content

docs: update README for Supabase env vars #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
numbpill3d wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update README for Supabase env vars #51

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ You can use these accounts to explore the platform:

### Prerequisites
- Node.js (v16 or higher)
- MongoDB (local or remote)
- Supabase project (URL and keys)

### Installation

Expand All @@ -77,7 +77,9 @@ You can use these accounts to explore the platform:
3. Create a `.env` file in the root directory with the following variables:
```
PORT=3000
MONGODB_URI=mongodb://localhost:27017/wirebase
SUPABASE_URL=your-supabase-url
SUPABASE_KEY=your-anon-key
SUPABASE_SERVICE_KEY=your-service-role-key
SESSION_SECRET=your-session-secret
NODE_ENV=development
```
Expand Down Expand Up @@ -118,9 +120,10 @@ You can use these accounts to explore the platform:
- `NODE_ENV`: `production`
- `SESSION_SECRET`: (generate a random string)
- `PORT`: `10000` (or use Render assigned port)
- `MONGODB_URI`: (your MongoDB connection string)

3. Create a MongoDB database and connect it to your service
- `SUPABASE_URL`: your Supabase project URL
- `SUPABASE_KEY`: your Supabase anon key
- `SUPABASE_SERVICE_KEY`: your Supabase service role key
3. Link your Supabase project to the service

## Customization

Expand Down Expand Up @@ -163,4 +166,4 @@ This project is available under the MIT License. See the [LICENSE](LICENSE) file
## Acknowledgements

- Design inspired by Windows 98 UI and medieval fantasy aesthetics, as well as by the Ethos and Feeling of the Wired, from Serial Experiments Lain. Temple OS also.
- Built with Express.js, MongoDB, and Handlebars
- Built with Express.js, Supabase, and Handlebars