Feature: Document necessary pathway to correctly set up local dev environment.

[JDGuillaume]

Type of feature

🍕 Feature

Current behavior

1. Currently, there's not a lot of documentation around the correct way to set up a fully-functional local dev environment to work on the hot repo.
2. Documentation does not clearly indicate which environmental variables should be used and which API a local dev environment should utilize (i.e., beta vs. current).
3. Documentation does not clearly indicate or explain how to set up a personal Supabase account https://github.com/open-sauced/api#-setting-up-your-supabase-instance.
4. Documentation does not clearly indicate or explain how to setup OAuth with GitHub.
5. Documentation does not currently explain or utilize Open Sauced's walkthrough of how to retrieve one's authentication token to enable API authorization locally Open Sauced Docs.

Suggested solution

• Create documentation that indicates a specific set of steps to establish a working local dev environment.
• Create a script or API endpoint that one can use for seeding their local Supabase database.
  • Ideally, this process would be isolated to the hot repo and not require extensive setup or pulling down of multiple repositories.

This issue is primarily an extension of https://github.com/open-sauced/api/issues/226, more focused on the hot repo.

After discussing with @jpmcb and @bdougie in the Open Sauced Discord, I was able to make a lot of headway toward spinning up a local dev environment, including:

• Spinning up a personal Supabase account.
• Setting up an OAuth App within GitHub and utilizing Supabase Auth.
• Using my production Authorization token to communicate with the Open Sauced API.

However, there's no current documentation or direction around populating the Supabase database with either the correct schema or seeding it with relevant data.

I would love the opportunity to tackle this documentation personally. However, I would like more guidance on the last mile work (i.e., populating the database). Currently, this is blocking progress on #416, as I'm not able to replicate the fully authenticated state and successfully fetch data from the database.

Additional context

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

Contributing Docs

• I agree to follow this project's Contribution Docs