Skip to content

Update readme with instructions for local devΒ #28

@nikfp

Description

@nikfp

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions