From 836d80c2255ab7b248800b6efc02b3b6dd4b7f19 Mon Sep 17 00:00:00 2001
From: Leonid Medovyy <leonid@storypro.io>
Date: Thu, 18 May 2023 08:17:07 -0700
Subject: [PATCH] adding env example

---
 .env.example | 42 ++++++++++++++++++++++++++++++++++++++++++
 README.md    | 14 +++++++++-----
 2 files changed, 51 insertions(+), 5 deletions(-)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..588fdcb
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,42 @@
+ORGANIZATION='Enterprise'
+
+APPSIGNAL_APP_ENV=local
+APPSIGNAL_APP_NAME='Enterprise'
+APPSIGNAL_PUSH_API_KEY=
+
+URL_WITHOUT_PROTOCOL=localhost:3000
+FROM_EMAIL='noreply@storypro.io'
+
+# Secret for accessing `/api/v1` endpoint.
+# We are not using this right now, but may in the future.
+API_KEY=secret
+
+# This can be generated via CLI by running `rails secret`
+SECRET_KEY_BASE=10ff4b08bafa4c8438c8ab9898909b9f0d5002abadd1b73017cbd6df2faf4f200dd5edc9a53e4406db438635b5204251304138136f2c1da22881c528c53fa37a
+
+# Head over to https://developer.feedly.com/v3/developer/ to get your own token.
+# Feedly Pro+ is required to access the AI features.
+FEEDLY_TOKEN=
+
+# Head over to https://openai.com/ to get your token and organization id.
+OPENAI_ACCESS_TOKEN=
+OPENAI_ORGANIZATION_ID=
+
+# Head over to https://www.thenextleg.io/, create an account, configure midjourney, and get your token.
+NEXT_LEG_TOKEN=
+
+# The URL of the platform is used for sharing links via social media.
+STORYPRO_URL=https://storypro-618-537-356-706.herokuapp.com
+STORYPRO_API_URL=https://storypro-618-537-356-706.herokuapp.com/api/v1
+
+# Head over to https://app.storypro.io/, log in, navigate to your platform, head over to settings and get your api key.
+STORYPRO_API_KEY=
+
+# Head over to https://www.uploadcare.com/, create an account, and get your public and secret keys.
+# ENsure that these are the same keys that you use on StoryPro.
+UPLOADCARE_PUBLIC_KEY=
+UPLOADCARE_SECRET_KEY=
+
+# Head over to https://www.ayrshare.com/, signup for an account and get an api key.
+# You will need a premium plan to send more then 20 messages per month.
+AYRSHARE_API_KEY=
\ No newline at end of file
diff --git a/README.md b/README.md
index 0896376..36f4c81 100644
--- a/README.md
+++ b/README.md
@@ -24,11 +24,15 @@ Our goal is to empower journalists, publishers, and content creators with the mo
 By harnessing the power of AI and these innovative integrations, Enterprise not only enhances the efficiency of your newsroom but also elevates the quality and impact of your content. Join us on this exciting journey as we redefine the future of journalism together!
 
 ## Setup Instructions
-0. Clone the repository and `cd` into it.
-1. Run the `rails generate blueprints` command to copy over the blueprint files to the `blueprints` directory.
-2. Modify the blueprint files to reflect the feeds and prompts you want to use by changing `topics.yml` and `prompts.yml`.
-3. Fine tune topic generation by excluding unwanted tags in `tunings.yml`.
-4. When finished, execute `rake blueprints:update` to load the changes into the database.
+1. Clone the repository and `cd` into it.
+2. Copy the `.env.example` file and create a new `.env` file: `cp .env.example .env`
+3. Open the newly created `.env` file and populate it with the relevant keys and values. Note that you may need to sign up for some services to obtain these keys. Instructions for obtaining each key are included as comments in the `.env.example` file.
+4. Run the `rails generate blueprints` command to copy over the blueprint files to the `blueprints` directory.
+5. Modify the blueprint files to reflect the feeds and prompts you want to use by changing `topics.yml` and `prompts.yml`.
+6. Fine tune topic generation by excluding unwanted tags in `tunings.yml`.
+7. When finished, execute `rake blueprints:update` to load the changes into the database.
+
+