aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..108d74c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Project purpose
+
+## Internal Apps
+### Accounts
+* adds profile to default Django user
+ * profile photo
+ * website
+ * bio
+ * location
+
+
+## Rational for external dependencies
+### Coverage
+[https://github.com/nedbat/coveragepy](https://github.com/nedbat/coveragepy)
+#### Why
+* gotta test
+* I hate keeping track of what needs tests
+### Python Decouple
+[https://pypi.org/project/python-decouple/](https://pypi.org/project/python-decouple/)
+####Why
+* Decouple helps you to organize your settings so that you can change parameters without having to redeploy your app.
+* Allows committing settings.py by keeping not-committed settings in one place (.env)
+
+### Django Taggit
+[https://github.com/alex/django-taggit](https://github.com/alex/django-taggit)
+####Why
+* Simplest way to get robust tagging capabilities
+* When I wrote my own, this is what I wrote
+
+
+### Django Storages
+[https://github.com/jschneier/django-storages](https://github.com/jschneier/django-storages)
+####Why
+* Simplest way to make all static assets go to Amazon S3
+* Simplifies migrating server setups by keep static assets off the server