Skip to content

ENG-549 Update database README with simplified setup and sync instructions #268

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

Closed
wants to merge 1 commit into from
Closed

ENG-549 Update database README with simplified setup and sync instructions #268

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
6 changes: 2 additions & 4 deletions packages/database/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,10 @@ All CLI commands below should be run in this directory (`packages/database`.)
1. Setup
1. Install [Docker](https://www.docker.com)
2. Install the [supabase CLI](https://supabase.com/docs/guides/local-development). (There is a brew version)
3. `supabase login` with your (account-specific) supabase access token. (TODO: Create a group access token.)
4. `supabase link`. It will ask you for a project name, use `discourse-graphs`. (Production for now.) It will also ask you for the database password (See 1password.)
5. Install [sqruff](https://github.com/quarylabs/sqruff)
3. Install [sqruff](https://github.com/quarylabs/sqruff)
2. Usage:
1. Use `turbo dev`, (alias for `supabase start`) before you use your local database. URLs will be given for your local supabase database, api endpoint, etc.
2. You may need to `supabase db pull` if changes are deployed while you work.
2. If schema changes are deployed while you work, rebase or merge the latest `main` branch to apply new migrations to your local database.
3. End you work session with `supabase end` to free docker resources.
3. Development: We follow the supabase [Declarative Database Schema](https://supabase.com/docs/guides/local-development/declarative-database-schemas) process.
1. Assuming you're working on a feature branch.
Expand Down