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.

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

more warnings #21

Merged
merged 1 commit into from
Jun 20, 2023
+10 −12
Merged

more warnings #21

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
12 changes: 5 additions & 7 deletions .env.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@


##################################################################################################
# NOTE: This is an important note!
# Do not edit and commit your .env.template with your personal keys, it might reveal you API keys
# copy this file to .env and only then edit your .env file not this file
# DO NOT COMMIT YOUR API KEYS OR EMAIL ADDRESS TO YOUR REPOSITORY
##################################################################################################
OPENAI_API_KEY=your_api_key
OPENAI_API_KEY=your_api_key # DO NOT COMMIT ANY FILE WITH THIS KEY SET

## EMAIL SETTINGS
SENDGRID_API_KEY=your_api_key
FROM_EMAIL=your_email
TO_EMAIL=your_email
SENDGRID_API_KEY=your_api_key # DO NOT COMMIT ANY FILE WITH THIS KEY SET
FROM_EMAIL=your_email # DO NOT COMMIT ANY FILE WITH THIS KEY SET
TO_EMAIL=your_email # DO NOT COMMIT ANY FILE WITH THIS KEY SET
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ To locally run the same UI as the Huggign Face space:

1. Install the requirements in `src/requirements.txt` as well as `gradio`.
2. Run `python src/app.py` and go to the local URL. From there you will be able to preview the papers from today, as well as the generated digests.
3. If you want to run the action locally you can copy .env.template to .env and then set the environment variables in the .env file.
- This file may be hidden by default in some operating systems due to the dot prefix. To reveal hidden files, follow the instructions for your
- The .env file is one of the files in .gitignore, this means that git does not track it and it will not be uploaded to the repository, accidentally.
- For this reason you should not edit the original .env.template and put the keys or your email address in the original file, since the .template.env is tracked by git and editing it might cause you to commit it with your API keys.
3. If you want to use a `.env` file for your secrets, you can copy `.env.template` to `.env` and then set the environment variables in `.env`.
- Note: These file may be hidden by default in some operating systems due to the dot prefix.
- The .env file is one of the files in .gitignore, so git does not track it and it will not be uploaded to the repository.
- Do not edit the original `.env.template` with your keys or your email address, since `.template.env` is tracked by git and editing it might cause you to commit your secrets.

> **WARNING:** This is an important note! Do not edit and commit your .env.template with your personal key, or email, it might reveal your personal data such as API keys and email.
> **WARNING:** Do not edit and commit your `.env.template` with your personal keys or email address! Doing so may expose these to the world!

## ✅ Roadmap

Expand Down