From 244d1e623da960c4d0d7b60d8ea69840a2ff89b1 Mon Sep 17 00:00:00 2001
From: kakulukia <andy@freilandkiwis.de>
Date: Fri, 11 Aug 2017 11:58:43 +0200
Subject: [PATCH] Create README.md

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4204f46
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+# django-default-project
+
+
+This is meant as a base template for new Django projects wich uses pipenv to manage its 3rd party packages. 
+the project comes preconfigured for those packages:
+  
+    [dev-packages]
+    django-debug-toolbar = "*"
+    django-livereload-server = "*"
+    flake8 = "*"
+    Fabric3 = "*"
+    
+    [packages]
+    Django = "*"
+    ipdb = "*"
+    ipython = "*"
+    pypugjs = "*"
+    django-secrets = "*"
+    django-undeletable = "*"
+    django-extensions = "*"
+    dj-static = "*"
+    django_compressor = "*"
+    django-axes = "*"
+    django-libsass = "*"
+    raven = "*"
+  
+Furthermore it inclueds a hello world with PUG template, SASS styles and VueJS. 
+jQuery and FontAwesome are also included for convenience. The project has a flat settings hirachy so you can do the following:
+
+ 1. Alice and Bob set an environment var pointing to their own settings like "settings.bob"
+ 2. When starting a new project they just have to copy setting/dev.py and change it to their liking
+ 3. When switching and working on multiple projects, everybody can have their own setting checked into the 
+ project and automatically using em without the need to remember to activate "<project_name>.settings.whatever" 
+ (influenced by the really cool TwoScoops of Django)
+ 
+ Django-secrets will keep your secrets really secret and help you with your deployment so that you anly need to initialize 
+ your secret environment variables. Also works super easy with i.e. Travis CI.
+ 
+ Django-axes is not working under 1.11, but i kept it anyways, hoping the functionality will return. :)
+ 
+ All assets and templates are stored in their top level folders .. yes i know its not portable that way, but most of 
+ the times i dont build portable apps. I create projects that are meant to be be running at customers and never 
+ see the public light and thus they shall be clean without the need to remember which assets are hiden in which subfolders.
+ The styles.sass in compiled on the fly and thanks to the wonderful livereload-server changes will be visible right away in
+ you browser (as well as code changes to python files).
+ 
+ Once the settings file ist fed with the needed credentials all errors (python and javascript) will be catched by 
+ Sentry.io for error handling. 
+ 
+ misc/setup_repo.sh will setup the current repo with a flake8 commit hook to always commit clean code only. :D
+ wsgi.py is patched with the awesome dj-static lib so you dont neccessarily need to remember to serve static 
+ files separately unless you really want to.
+ 
+ Because pipenv didnt work that well in its early stages, there is still a requirements.txt. Have to play a little 
+ more with pipenv to be a little more confident to completely switch, but installing a lot of stuff is still a 
+ lot using plain pip. The Pipfile is a lot better to manage tho. So for now i partly use both.
+ 
+ One more thing: The project template features a ready to use fabfile which will grant you some basic tasks like:
+ 
+   - _fab deploy_ which will push your content and restart uwsgi
+   - _fab migrate_ which will push updates, updating packages, migrating the DB, compressing files, collecting 
+   static files and finally restart the server for you.
+   
+ Hope i didnt forget any gem inside .. have fun with this project template!