Skip to content

Add support for using environment file .env and update readme with additional instructions.#1

Open
peiyaoh wants to merge 2 commits intomainfrom
update-readme
Open

Add support for using environment file .env and update readme with additional instructions.#1
peiyaoh wants to merge 2 commits intomainfrom
update-readme

Conversation

@peiyaoh
Copy link
Collaborator

@peiyaoh peiyaoh commented Nov 21, 2025

Using a .env file provides a secure and flexible way to manage configuration variables (like the database connection string) separately from the source code. This is essential because the connection string could contain sensitive credentials and will be different for every user.

Added Mac-specific conda environment creation instructions and expanded the PostgreSQL setup section with download link and example commands for creating a database.
Added python-dotenv to environment files and updated config.py to load environment variables from a .env file. Updated README to instruct users to set the database URI in a .env file instead of editing config.py directly. Also updated .gitignore to exclude .env files. Using a .env file provides a secure and flexible way to manage configuration variables (like the database connection string) separately from your source code. This is essential because the connection string could contain sensitive credentials and will be different for every user.
@peiyaoh peiyaoh requested a review from ZipingXu November 21, 2025 00:33
@peiyaoh
Copy link
Collaborator Author

peiyaoh commented Nov 26, 2025

Hi @ZipingXu Just want to follow up to see if you have a chance to review this pull request.

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

Successfully merging this pull request may close these issues.

1 participant