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

Missing documentation / environment variables for local development #54

Open
navFooh opened this issue Jun 7, 2024 · 0 comments
Open

Comments

@navFooh
Copy link

navFooh commented Jun 7, 2024

The documentation doesn't mention steps to get started with development on a local machine. It does mention environment variables in the "Deployment" section of the README, but I think it would make sense to have an .env.local or .env.local.example file in the repo with a base set of environment variables (or placeholders) that are required to run the project.

Since the code assumes that some environment variables are present, just using the documentation to get started results in a bunch of errors. I think it would help to not assume the variables are present, but check if they are set at runtime and display a user friendly error message in the UI if something is missing.

Of course it would be tricky with some values or contracts to have presets for demo purposes, but maybe it's an idea to default to a testnet where a mock contract is deployed that will always issue some tokens to a user in the claim flow. Then the demo could be made completely functional.

Sidenote, the siteName and WALLLET_CONNECT_ID values exported from constants\site.ts are never referenced. Also, WALLLET_CONNECT_ID does not use the value from process.env.NEXT_PUBLIC_WALLET_CONNECT_PROJECT_ID. I'm not sure if the idea behind this file was to provide defaults for the enviroment variables, but in that case it's not complete or used consistently.

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

1 participant