You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Description:
To make the project more flexible and user-friendly, we should add support for an optional .env file. This file will allow users to override default configurations (e.g., database credentials, versions, etc.) without modifying the Makefile directly. This is particularly useful for local development and testing, where users may need to customize settings.
Why is this needed?
Currently, all configurations are hardcoded in the Makefile, which makes it difficult to customize settings without editing the file.
Using a .env file is a standard practice for managing environment-specific configurations.
It simplifies the process of overriding defaults (e.g., database credentials, versions, etc.) without requiring changes to the Makefile.
Requirements:
Load .env File:
The Makefile should check for the existence of a .env file in the root directory.
If the .env file exists, load its variables and override the default values in the Makefile.
Environment Variable Precedence:
Environment variables set in the shell should take precedence over values in the .env file.
The .env file should take precedence over default values in the Makefile.
Documentation:
Update the README.md to explain how to use the .env file for configuration overrides.
Provide an example .env file with all supported variables.
Example .env File:
Include a .env.example file in the repository with all supported variables and their default values. This will serve as a template for users.
The text was updated successfully, but these errors were encountered:
Add
.env
File Support for Configuration OverridesDescription:
To make the project more flexible and user-friendly, we should add support for an optional
.env
file. This file will allow users to override default configurations (e.g., database credentials, versions, etc.) without modifying theMakefile
directly. This is particularly useful for local development and testing, where users may need to customize settings.Why is this needed?
Makefile
, which makes it difficult to customize settings without editing the file..env
file is a standard practice for managing environment-specific configurations.Makefile
.Requirements:
Load
.env
File:Makefile
should check for the existence of a.env
file in the root directory..env
file exists, load its variables and override the default values in theMakefile
.Environment Variable Precedence:
.env
file..env
file should take precedence over default values in theMakefile
.Documentation:
README.md
to explain how to use the.env
file for configuration overrides..env
file with all supported variables.Example
.env
File:.env.example
file in the repository with all supported variables and their default values. This will serve as a template for users.The text was updated successfully, but these errors were encountered: