Spaces:
Sleeping
Sleeping
Commit
·
6a1f5f0
1
Parent(s):
9455411
added explnation on the .env.tempalte risk
Browse files
README.md
CHANGED
@@ -84,8 +84,11 @@ To locally run the same UI as the Huggign Face space:
|
|
84 |
1. Install the requirements in `src/requirements.txt` as well as `gradio`.
|
85 |
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.
|
86 |
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.
|
|
|
|
|
|
|
87 |
|
88 |
-
> **NOTE:** This is an important note! Do not commit
|
89 |
|
90 |
## ✅ Roadmap
|
91 |
|
|
|
84 |
1. Install the requirements in `src/requirements.txt` as well as `gradio`.
|
85 |
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.
|
86 |
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.
|
87 |
+
- 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
|
88 |
+
- 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.
|
89 |
+
- For this reason you should not edit the original .env.template and put the keys 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.
|
90 |
|
91 |
+
> **NOTE:** This is an important note! Do not edit and commit your .env.template with your personal key, it might reveal you API keys.
|
92 |
|
93 |
## ✅ Roadmap
|
94 |
|