Django-Startup-Project-Tutorial

Pro Series - Web Framework Django/python workshop Let's Code Blacksburg! Tuesday, December 13, 2016 from 5:30 PM to 8:00 PM (EST) Blacksburg, VA

Updated to use Docker (removed CodeAnywhere)

---

1. Slide (Overivew):

   • Overall Goal of this session:
     • Demonstrate the value Django can bring inside your organization
       • By showing how fast and easy it is to spin up a DB driven website
       • By showing off the autogenerated admin console
       • Why Django might be better than a typical CMS (WordPress, Drupal, Joomla, etc)
         • Basically all CMS's will need a programmer to extend and customize and you are still left with a messy customization
         • Django start with a developer and get exactly what you need.
           • More quickly get to market
           • Less of what you don't need
           • Minimize the amount of work not done
     • Django major features:
       • Amazing Documentation
       • Python is easy language to learn and is clean (DRY, TDD, PEP08, etc)
       • Auto generated Admin console
       • ORM built in (and easy to use)
       • TDD

---

2. Slide (Getting started):

   • We only have 2 hours so we will be using Docker to spin things up quickly
     • Allows us to skip python & django installation (since it will be done inside the Docker container)
   • We will rely heavily on github repo sample pre-built before the class for code snippets
     • https://github.com/atuggle/Django-Startup-Project-Tutorial
   • What is covered:
     • Project creation (using docker)
     • Understand Django Project vs Apps
     • ORM: Creating Models and Database Objects
     • CRUD: Using the Admin to Create, Read, Update, & Delete our data
     • Using TMV to create Django HTML Templates
     • Python Shell, for exploring data in DB
     • Web Forms in Django Templates

---

3. Slide (Getting the code up and running!):

   1. Ensure Docker is running on your machine
   2. Open gitbash and run the docker command found here in the folder you want to create your code in:
      • https://hub.docker.com/r/mchughmk/django-starter
      • Name the project EventManager do not use - in the name
   3. CD into your new folder EventManager and execute this command:

      • %>docker-compose up -d

   4. Navigate to https://localhost:8000
   5. Verify you are seeing the Django project start up page
   6. Open code using VS Code

      • %>code .

---

4. Slide (Working with the Docker Container):

   • Executing commands inside the container shell:

     • %>docker-compose exec web bash OR %>docker-compose exec web whoami

   • Other usefull commands

     • %>docker-compose logs -f web %>docker-compose start %>docker-compose stop %>docker-compose down %>docker-compose web --build

---

5. Slide (%> python manage.py):

   • Discuss manage.py
   • Discuss difference in Projects and Apps in Django
   • Initial project already created thanks to docker:
   • See command in docker file
     • django-admin.py startproject projectname

---

6. Slide (Admin Console):

   • I was told there would be a free admin console?
   • First we must create a super user in the db:

     • %>docker-compose exec web bash (bash)%>python manage.py createsuperuser Follow prompts

     • Navigate to your app /admin:
       • https://localhost:8000/admin
       • Notice there is already "Groups" & "Users"

---

7. Slide (Create events app):

   • Must create an app inside our Django project.
   • You can have multiple apps but today we will just have one

     • (bash)%>python manage.py startapp events

   • Connect events app to project
     • Add the below line to the "INSTALLED_APPS" section of the settings.py file
       • 'events.apps.EventsConfig'
   • SEE branch: release-one-projectapp-creation

---

8. Slide (Create db models for ORM):

   • Create Models:
     • Event(models.Model)
       • Name
       • Date_time
       • Description
       • Enabled
     • Person
       • Name
       • Email
     • Attendance
       • Person
       • Event
   • See (Model.py code to copy/paste): Click Me

---

9. Slide (ORM migrations):

   • Discuss ORM

     • %> python manage.py makemigrations

     • %> python manage.py migrate

     • %> python manage.py migrate 0003 (targeted migration "roll back")

   • Look at migrations folder
     • Review 00001_initial.py file it created
   • SEE branch: release-3-projectapp-models

---

10. Slide (Free Admin CRUD pages for models):

    • Register models in admin.py:
      • Edit events/admin.py:
        • See code here
      • Refresh admin
      • Discuss Admin consoles
    • SEE branch: release-6-projectapp-templates

---

11. Slide (MVC vs Django's TMV):

    • Discuss MVC vs TMV
      • Django is not true MVC, but it is equally as optimal
      • Compareing the two:
        • Template is view
        • View is controller
        • Model is model
        • Urls.py maps the route

---

12. Slide (urls.py & Routes):

    • Create events/urls.py:

       from django.conf.urls import url
       from . import views
       
       app_name = 'events'
       
       urlpatterns = [
       	url(r'^\$', views.index, name='index'),
       	# url(r'^(?P<event_id>[0-9]+)/$', views.detail, name='detail'),
       ]
      

      • See code here
    • Connect EventManager/urls.py to EventManager/events/url.py

       from django.conf.urls import include, url
       from django.contrib import admin
      
       urlpatterns = [
       	url(r'^admin/', admin.site.urls),
       	url(r'^events/', include('events.urls')),
       ]
      

      • See code here

---

13. Slide (Test route is working):

    • Create basic "Hello World" in views.py
      • Ensure "HttpResponse" has been imported in the top "from ..." line
      • Add below code

       def index(request):
       	return HttpResponse('Hello World')
      

    • SEE branch: release-2-projectapp-view

---

14. Slide (HTML Templates!):

    • Create Templates and connect to view:
      • Discuss why duplication of app name in template folder
      • events/templates/events/index.html
        • Code Here
      • events/templates/base.html
        • Code Here
      • Template inheritance via {% block name %} [% endblock %}
      • Events/static/events/starter-template.css
        • Code Here

---

15. Slide (Connect our view.py (controller) to our html templates):

    • Connect view.py to templates:
      • Add linked code to view.py Just the function def index
        • Code Here
    • SEE branch: release-4-projectapp-templates

---

16. Slide (python shell for data evaluation):

    • Discuss shell

       %>python manage.py shell
        
       from events.models import Event, Person, Attendance
       Event.objects.all() 
       e = Event(name='event one', description='this is the description')
       e.save() 
       e.date_time
       e = Event(name='event two', description='this is the description for event two')
       e.save()
       Event.objects.filter(name__endswith='two')  
       quit()      <- to quit
      

---

16. Slide (Web Forms & Django Templates):

    • Discuss Forms:
    • Create RegisterForm(forms.Form)
      • Create events/forms.py file
        • Sample Code Here

---

17. Slide (Web Forms continued):

    • Create form and detail.html:
    • Events/templates/events/details.html
      • Sample Code Here
    • Uncomment line un urls.py so details route will work
    • Update views.py to look like this:
      • Sample Code Here
    • Use the form to create one or more attendance records in db
    • SEE branch: release-5-projectapp-forms

---

18. Slide (What's next?):

    • Q & A
    • What next:
    • Resources:
      • https://www.djangoproject.com/
        • View both the tutorial & overview
      • Book: "Two Scoops of django" by Daniel Greenfeld and Audrey Roy