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

Document the API keys needed to develop #302

Open
chartgerink opened this issue Sep 18, 2024 · 2 comments
Open

Document the API keys needed to develop #302

chartgerink opened this issue Sep 18, 2024 · 2 comments

Comments

@chartgerink
Copy link
Member

In reviewing #301, I noticed I cannot run npm run test because it requires a Resend API key.

As far as I know, this key is undocumented in the project and hence, makes it harder to setup the testing environment for developers. It might help to get an overview of these potential issues, and workarounds if relevant.

I ended up running vitest <file> instead, so it was not a blocker, but the Resend API key will be needed if somewhere in the deployment/testing process we want to be able to run npm run test.

Are there any other API keys that are critical?

@doomlab
Copy link
Member

doomlab commented Sep 27, 2024

Alright @chartgerink - question - do we think we can move the tests for these two (login checks) to like production environment or something else? Basically, we wouldn't want to mandate this specific email setup as part of tests. Thoughts?

@chartgerink
Copy link
Member Author

You could add the workaround to only run these tests if the relevant environment variables are necessary. This way they would work both in production and the staging area/dev deployment.

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

2 participants