Skip to content

Prevent bundling of .env and document secure handling of API keys #4

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.

Sign up for GitHub

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

Open
Ishaan400 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Prevent bundling of .env and document secure handling of API keys #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,11 @@ DocPilot is a Flutter application designed to assist healthcare providers in rec
DEEPGRAM_API_KEY=your_deepgram_api_key
GEMINI_API_KEY=your_gemini_api_key
```

Important: Do NOT commit your `.env` file. It contains sensitive API keys.
Use `.env.example` as a template and add `.env` to your `.gitignore`.
For CI or shared environments, store secrets in your CI provider's secret
management system or environment variables instead of committing them.

4. Run the app:
```bash
Expand Down
4 changes: 2 additions & 2 deletions pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ dev_dependencies:

# The following section is specific to Flutter packages.
flutter:
assets:
- .env
# No assets to bundle by default. Keep secrets out of assets.

# The following line ensures that the Material Icons font is
# included with your application, so that you can use the icons in
Expand Down Expand Up @@ -93,3 +92,4 @@ flutter:
#
# For details regarding fonts from package dependencies,
# see https://flutter.dev/to/font-from-package