Incomplete Local Development Setup Documentation

[shashankshet]

I attempted to set up the local development environment for the Midday project, but it seems the documentation isn't fully updated. Some steps, particularly those related to environment variables, are missing. It would be great if we can have the end to end local setup documented.

[pontusab]

Hey! Correct, I will write that after our v1 is done!

[absolutegravitas]

@shashankshet - i managed to just have a local version running(sort of) . I've currently got a db / ui bug #248 with supabase authenticated user & team views.

See how you go with below -- this assumes some level of knowledge about these linked services, getting and setting keys etc. I can navigate the website static pages (had some trouble with the component complaining about making their key visible (because of NEXT_PUBLIC prefix on the NEXT_PUBLIC_TRIGGER_API_KEY which is Trigger.dev so i commented that out for now). I can login with Google oAuth and GitHub (which i set up myself by adding to the .src/apps/api/supabase/config.toml file but havent managed to get to the vanilla dashboard due to #248 mentioned above.

1. find and set keys in .env files for the various integrated services by visiting the requisite sites - for mine I set up the following:
   • apps/api/.env with oAuth id / key for Google (you will have to follow google cloud oAuth instructions to do this). Callback URL to supply on google side is the supabase auth callback (shown when you fire up supabase locally)

• in apps/api/.env PROJECT_ID i believe is supabase project id which is local for supabase locally

• in apps/dashboard/.env, i set and provided every key EXCEPT loops, gocardless, teller, plaid, plain, openai, mistral as I just wanted to load and get to the dashboard post login for my first attempt. I also didnt bother with Sentry and commented out Sentry code everywhere in the workspace because of my related issue about their garbage error message about DSN key not being valid (see https://github.com/midday-ai/v1/issues/46)

• in apps/website/.env setting all the requested keys by going to the requisite app website and getting keys.

2. install supabase cli https://supabase.com/docs/guides/cli/getting-started?queryGroups=platform&platform=linux - i dont think you dont need to do anything including after supabase init as the midday repo already has supabase config

3. run bun i in project root to install packages

4. run bun dev in project root (first time takes a while in case supabase needs to pull docker images and start the container and run the migrations & seed scripts). This message contains details about your postgres server, the supabase keys to set in the .env files above and the callback URL for supplying to google oAuth (or other providers that you configure in supabase auth)

5. assuming you've done this correctly

   • the website aka ./src/apps/website is available at localhost:3000
   • the dashboard aka after you login aka ./src/apps/dashboard is available at localhost:3001
   • other links e.g. local supabase studio / inbucket email sim / storybook etc. are in the terminal under various localhost ports.

[luchoster]

have you been able to connect to a bank account with Plaid?

I have the project running for a while but I can't get the Plaid connection to work. Whenever I click the connect, I get this error

Console:

[absolutegravitas]

sorry bud not a North American -- got no plaid account / access to test any of the bank integrations with