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

[Feature] Sample env file in the Codebase #47

Open
i0dheerajdileep opened this issue Dec 1, 2024 · 0 comments
Open

[Feature] Sample env file in the Codebase #47

i0dheerajdileep opened this issue Dec 1, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@i0dheerajdileep
Copy link

🚀 Feature Request: Add a .env.sample File

Description

Introduce a .env.sample file to the repository to standardize and simplify the setup process for managing environment variables.

Motivation

Managing environment variables without a clear template can be challenging, especially for new developers. The absence of a .env.sample file leads to confusion about:

  • Which variables are required.
  • The purpose of each variable.
  • The expected format or example values.

Adding a .env.sample file will streamline onboarding and reduce errors caused by misconfigured or missing variables.

Proposed Solution

Create a .env.sample file in the root of the repository with the following:

  • Placeholders for all required environment variables.
  • Comments explaining the purpose of each variable.
  • Example values (if applicable).

Example

# Required API key for authentication
API_KEY=your_api_key_here

# RPC endpoint URL
RPC_URL=https://your.rpc.url

# Private key for signing transactions
PRIVATE_KEY=your_private_key
@i0dheerajdileep i0dheerajdileep added the enhancement New feature or request label Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant