Skip to content
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.

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

Improved Playground Documentation #38

Open
cherbel opened this issue Aug 24, 2023 · 0 comments
Open

Improved Playground Documentation #38

cherbel opened this issue Aug 24, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@cherbel
Copy link
Member

cherbel commented Aug 24, 2023

We need to create more comprehensive self hosting instructions in the readme. As a follow up to #34.

  • It should be documented that google needs to be enabled as an auth provider in supabase with some helpful instructions on how to set it up.
  • Documentation on how to create tables in supabase. Was able to run the sql from server/sql_setup/tables/ in the subabase SQL editor to create the tables.
  • Documentation on how to create functions in supabase. We created them manually in the database -> functions tab. Currently two functions need to be created with the names deduct_rate, and get_attempt_aggregates. Functions definitions can be found at server/sql_setup/functions/
    • deduct_rate
      • Inputs: input_api_key (text), rate (integer)
      • Return type: integer
      • Advanced settings language: plpqsql
    • get_attempt_aggregates
      • Input: user_id (uuid)
      • Return type: jsonb
      • Advanced settings language: sql
  • Documentation on how to initialize these resources automatically if possible.
  • Enabling row level security
@cherbel cherbel added the documentation Improvements or additions to documentation label Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant