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

Update readme with instructions for local dev #28

Open
10 tasks
nikfp opened this issue Feb 1, 2023 · 2 comments
Open
10 tasks

Update readme with instructions for local dev #28

nikfp opened this issue Feb 1, 2023 · 2 comments

Comments

@nikfp
Copy link

nikfp commented Feb 1, 2023

As part of bringing people on board to help build this repo, a guide in the README.md explaining how to build the app and get it running locally will be required. From what I've been able to dig up so far, the following items will need to be clarified.

  • Clarification of how the app interacts with Supabase and how Supabase should be configured to populate data, allow auth, etc.
    • Supabase might also have a way to extract an sql query that devs can run on their own instance to match the LBT schema.
    • Connecting and running pg_dump with the --schema-only flag should also be enough
    • Also need to address seed data if required.
  • Quick explanation of how to set up a local .env file to pass Supabase credentials into the app
  • Building and running the app locally
    • Address whether support should be included for alternate package managers or stick with strictly NPM
    • Make sure no global dependencies are expected on a dev's system - Typescript, Vite, etc.
  • Address code quality expectations - formatting, linting, etc. (Can address most through config)
    • Should a check command be added to local scripts in package.json?

Also please comment with any items I'm missing and I'll add them to the list.

@rossrobino
Copy link

This would be great, would love to find a way to contribute

@waseem-medhat
Copy link
Contributor

As someone willing to work on the HTML/CSS parts of the website, I would find it extremely convenient if the project can be configured (via an env variable maybe?) to use some mock data to render the (otherwise) dynamic content without having to call Supabase at all... Just a thought.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants