Deployment enh - Docker, Heroku, Gunicorn

Author: fullstack-superdev

.env

@@ -1,4 +1,3 @@
 DEBUG=True
 SECRET_KEY=s3cr3t_key
 DATABASE_URL=sqlite:////tmp/db.sqlite3
-PROD_HOST=django-dashboard-black.herokuapp.com

.gitignore

@@ -20,3 +20,6 @@ venv
 
 # javascript
 package-lock.json
+
+staticfiles/*
+!staticfiles/.gitkeep 

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.6
+
+ENV FLASK_APP run.py
+
+COPY manage.py gunicorn-cfg.py requirements.txt .env ./
+COPY app app
+COPY authentication authentication
+COPY core core
+
+RUN pip install -r requirements.txt
+
+RUN python manage.py makemigrations
+RUN python manage.py migrate
+
+EXPOSE 5005
+CMD ["gunicorn", "--config", "gunicorn-cfg.py", "core.wsgi"]

Procfile

@@ -1 +1 @@
-web: gunicorn core.wsgi --log-file -
+web: gunicorn core.wsgi --log-file=- 

Procfile.windows

@@ -2,13 +2,25 @@
 
 **Open-Source Admin Dashboard** coded in **[Django Framework](https://www.djangoproject.com/)** - Provided by **AppSeed** [Web App Generator](https://appseed.us/app-generator).
 
-### Dashboard Features:
+### Dashboard Features
 
 - SQLite, Django native ORM
 - Modular design
 - Session-Based authentication (login, register)
 - Forms validation
-- UI Kit: **Black Dashboard** provided by **Creative-Tim**
+- UI Kit: **Black Dashboard** (Free Version) by **Creative-Tim**
+
+### Deployment Scripts
+
+- **Heroku** - Cloud Application Platform
+- **Docker** - execute the app using a sandboxed container
+- **Gunicorn** / Nginx - a common used configuration for Django Apps
+- **Waitress** - Gunicorn equivalent for Windows.       
+
+### Web App Links
+
+- [Django Dashboard Black](https://appseed.us/admin-dashboards/django-dashboard-black) - product page 
+- [Django Dashboard Black](https://django-dashboard-black.herokuapp.com/) - LIVE Demo
 
 <br />
 
@@ -61,16 +73,117 @@ $ # Access the web app in browser: http://127.0.0.1:8000/
 
 <br />
 
+## Deployment
+
+The app is provided with a basic configuration to be executed in [Heroku](https://heroku.com/), [Docker](https://www.docker.com/), [Gunicorn](https://gunicorn.org/), and [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/).
+
+### [Heroku](https://heroku.com/) platform
+
+```bash
+$ # Get the code
+$ git clone https://github.com/app-generator/django-dashboard-black.git
+$ cd django-dashboard-black
+$
+$ # Heroku Login
+$ heroku login
+$
+$ # Create the app in Heroku platform
+$ heroku create # a random name will be generated by Heroku
+$
+$ # Disable collect static 
+$ heroku config:set DISABLE_COLLECTSTATIC=1
+$
+$ # Push the source code and trigger the deploy
+$ git push heroku master
+$
+$ # Execute DBSchema Migration
+$ heroku run python manage.py makemigrations
+$ heroku run python manage.py migrate
+$
+$ # Visit the deployed app in browser.
+$ heroku open
+$
+$ # Create a superuser
+$ heroku run python manage.py createsuperuser
+```
+
+<br />
+
+### [Docker](https://www.docker.com/) execution
+---
+
+The application can be easily executed in a docker container. The steps:
+
+> Get the code
+
+```bash
+$ git clone https://github.com/app-generator/django-dashboard-black.git
+$ cd django-dashboard-black
+```
+
+> Start the app in Docker
+
+```bash
+$ sudo docker-compose pull && sudo docker-compose build && sudo docker-compose up -d
+```
+
+Visit `http://localhost:5005` in your browser. The app should be up & running. 
+
+<br />
+
+### [Gunicorn](https://gunicorn.org/)
+---
+
+Gunicorn 'Green Unicorn' is a Python WSGI HTTP Server for UNIX.
+
+> Install using pip
+
+```bash
+$ pip install gunicorn
+```
+> Start the app using gunicorn binary
+
+```bash
+$ gunicorn --bind=0.0.0.0:8001 core.wsgi:application
+Serving on http://localhost:8001
+```
+
+Visit `http://localhost:8001` in your browser. The app should be up & running.
+
+
+<br />
+
+### [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/)
+---
+
+Waitress (Gunicorn equivalent for Windows) is meant to be a production-quality pure-Python WSGI server with very acceptable performance. It has no dependencies except ones that live in the Python standard library.
+
+> Install using pip
+
+```bash
+$ pip install waitress
+```
+> Start the app using [waitress-serve](https://docs.pylonsproject.org/projects/waitress/en/stable/runner.html)
+
+```bash
+$ waitress-serve --port=8001 core.wsgi:application
+Serving on http://localhost:8001
+```
+
+Visit `http://localhost:8001` in your browser. The app should be up & running.
+
+<br />
+
 ## Support
 
 - Free support via eMail < [support @ appseed.us](https://appseed.us/support) > and **Github** issues tracker
 - 24/7 Live Support via [Discord](https://discord.gg/fZC6hup) for paid plans and commercial products.
 
 <br />
 
-## Credits & Links
+## Credits
 
-- [Django Dashboard Black](https://www.youtube.com/watch?v=czv4Ww6rjMU) - yTube presentation
+- [Django Dashboard Black](https://www.youtube.com/watch?v=RJkCTn55ywo) - yTube presentation
 - [Django Framework](https://www.djangoproject.com/) - Offcial website
 - [Django Admin Dashboards](https://appseed.us/admin-dashboards/django) - Open-source and paid admin panels coded in **Django**
 

README.md

@@ -17,7 +17,7 @@
 def login_view(request):
     form = LoginForm(request.POST or None)
 
-    msg = 'Sign in with credentials'
+    msg = None
 
     if request.method == "POST":
 
@@ -37,7 +37,8 @@ def login_view(request):
 
 def register_user(request):
 
-    msg = 'Add your credentials'
+    msg     = None
+    success = False
 
     if request.method == "POST":
         form = SignUpForm(request.POST)
@@ -46,10 +47,15 @@ def register_user(request):
             username = form.cleaned_data.get("username")
             raw_password = form.cleaned_data.get("password1")
             user = authenticate(username=username, password=raw_password)
-            return redirect("/login/")
+
+            msg     = 'User created.'
+            success = True
+            
+            #return redirect("/login/")
+
         else:
             msg = 'Form is not valid'    
     else:
         form = SignUpForm()
 
-    return render(request, "accounts/register.html", {"form": form, "msg" : msg})
+    return render(request, "accounts/register.html", {"form": form, "msg" : msg, "success" : success })