docs: add comments on requirements.txt files with respect to Heroku

kevinjalbert · kevinjalbert · commit a9c9a956272c · 2020-02-29T16:10:16.000-05:00
Just adding a bit more information so that it is clear on why things are
like they are.
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,3 @@
+# Due to how Heroku applications are deployed, we need to be able to install the `server`
+# dependencies from the root directory. There also needs to be a `Procfile` to start things up
 -r ./server/requirements.txt
diff --git a/server/requirements.txt b/server/requirements.txt
@@ -5,4 +5,4 @@ Flask==1.0.3
 gunicorn==19.9.0
 Flask-APScheduler==1.11.0
 requests==2.22.0
--e ./shared
+-e ./shared # When this file is pip installed, the current working directory is the root of the project

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
	`1`	+# Due to how Heroku applications are deployed, we need to be able to install the `server`
	`2`	+# dependencies from the root directory. There also needs to be a `Procfile` to start things up
`1`	`3`	`-r ./server/requirements.txt`