- This document assumes you have fundamental Linux command line interface understandings
- VI Text Editor is my editor of choice due to its portibitilty and how its on nearly all Linux systems.
- Acquired image on 02/06/2021
- Ubuntu Desktop 20.04.2 LTS (file name =
ubuntu-20.04.2-desktop-amd64.iso) - Debian-based
- ISO file size: ~2.67-gigs (exact =
2,877,227,008 bytes) - Link: Download Ubuntu Desktop
- Link: Release Notes
- Note: If you're using a Virtual Machine via "VMware" or "Virtual Box" or one of the others... remember to mount the .iso image so that you may install the operating system with ease.
- Package Manager Information: Advanced Package Tool(APT)
If you're curious about how to do this manually, go here.
- Copy install.sh into a directory on your Ubuntu server.
- Or copy and contents into a file using
vi install.sh - Press
iwhile in VI to enable "Editing mode" Right-clickyour mouse and paste the contents within.- To save and exit the file type
:wq(colon, w, q)
- Or copy and contents into a file using
- Give it read-write-execute permissions
chmod 777 install.sh - Prior to executing, please ensure you're logged in at the primary user on the account (not root, but the account you'll be using regularly)
- Execute script by typing the following into your CLI (
./install.sh) - Script will prompt you some questions, you will need a github account setup.
- Just answer the questions and the script should handle the rest.
Note: If you receive something along the lines of "./install.sh: line 4: $'\r': command not found"... Then that means Windows (or some process) has appended "carriage return" to every single line within the script. Linux can't interpret these symbols therefore we'll need to convert the file within the Linux Command Line Terminal. (See dos2unix for more details)
Okay great, the script installed and configured a number of items for us to get the ball rolling on this web project.
cd django/
django-admin startproject Django_StarterPack # Give a name to the overall application
# Note: Directory will look like /Django_StarterPack/Django_StarterPack/# [As ${USER}]
cd Django_StaterPack # Navigate to freshly created application folder
vi Django_StarterPack/settings.py
# Modify ALLOWED_HOSTS = ["*"] # WARNING: NOT IDEAL FOR PRODUCTION ENVIRONMENT
# Add "postgreSQL" to the list of DATABASES = {} # (See link: "postgreSQL_syntax)
# Modify "TIME_ZONE" to your native time. # (See link: "List of database time zones")- Link: postgreSQL syntax
- Link: List of database time zones
# [As ${USER}]
# This will initialize the appropriate files / folders
# for storing the actual web application
python3 manage.py startapp main_app
vi Django_StarterPack/settings.py
# Add "main_app" to the list inside of INSTALLED_APPS = []- Note: On Windows, follow this guide Windows Postgresql installation guide
# [As ${USER}]
# Triple check that postgres password is setup correctly
sudo su postgres
psql
# Remember to use the user/password you selected in the above postgrSQL section
ALTER USER dbadmin WITH PASSWORD 'secureDBpassword';
\q
exit # Or (CTRL+D)
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py createsuperuser # Create a super user to interact with Django
# username = dbadmin | email = | password = secureDBpassword
# Just used the same profile that manages the database, to manage the Django framework
# Test configuration by running the Django server
python3 manage.py runserver 0.0.0.0:8000If you're able to navigate to "127.0.0.1:8000" in any web browser then you've successfully configured this machine to run Django.
# [As ${USER}]
vi Django_StarterPack/urls.py
# Add url for "main_app" and redirect "" -> "main_app"
# Enable serving of static files (CSS, JS, HTML, IMAGES, GIFS, etc...)Note: Add ,include to the below file.
# Libraries
from django.contrib import admin
from django.urls import path, include
from django.views.generic import RedirectView
# Default URL
urlpatterns = [
path('admin/', admin.site.urls),
]
# Custom URL
urlpatterns += [
path('main_app/', include('main_app.urls')),
path('', RedirectView.as_view(url='main_app/', permanent=True)),
]
# Serving static files
from django.conf import settings
from django.conf.urls.static import static
# Location of "static/" folder
urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)cd main_app/
vi urls.py
# Add path for index
# (See example below)
#### urls.py
# Libraries
from django.urls import path
from . import views
# Custom URL schema
urlpatterns = [
path('', views.index, name='index'),
]
#### END urls.py EXAMPLE
vi views.py
# Add index view
# (See example below)
#### views.py
from django.shortcuts import render, HttpResponseRedirect
from django.http import HttpRequest, HttpResponse
# Create your views here.
# Import database Classes # (LEAVE BELOW LINE BLANK UNTIL YOU'VE CREATED DATABASE TABLES)
# from main_app.models import Student # (Example piece).
def index(request):
"""View function for home page of website."""
# Acquire values from Django database and store them into this dictionary.
context = {}
# Render webpage
return render(request, 'index.html', context=context)
#### END views.py EXAMPLE
# templates/ folder is where the reusable HTML code sections will reside.
mkdir templates/
vi templates/index.html
# Just add something here... example "hello world"
cd ../ # Navigate back to parent directory# [As ${USER}]
vi main_app/models.py
# See https://developer.mozilla.org/en-US/docs/Learn/Server-side/Django/Models#author_model for example of how to create the models.
# Note: Will be coming back in the future to provide an example.Link: Example of Model creation
# [As ${USER}]
cd ~/django/Django_StarterPack # Navigate to application directory, if needed.
vi main_app/admin.py # Open admin file to register newly created databases.# admin.py
from .models import Member, Products, Transactions
admin.site.register(Member)
admin.site.register(Products)
admin.site.register(Transactions)# [As ${USER}]
python3 manage.py makemigrations # Make database model changes
python3 manage.py migrate # Commit changes
python3 manage.py runserver 0.0.0.0:8000 # Start server- Had an issue where "127.0.0.1:8000/admin" wouldn't allow me to log in. Re ran the following to resolve.
python3 manage.py createsuperuser # Create a super user to interact with Django # username = dbadmin | email = | password = secureDBpassword
- Had an issue where the database tables weren't being generated when using
python3 manage.py makemigrationsHowever, discovered that sometimes you need to explicitly target the django "INSTALLED_APP".Source: StackOverflow Posting && also error output from Django Application# Specifically I mean to do the following python3 manage.py makemigrations main_app # As described above python3 manage.py migrate main_app
- Need to close your SSH connection / Terminal for any reason? See "screen" from GNU software... (Use case below)
Source: StackOverflow
# Log into Terminal screen # Activates the screen package (if downloaded) cd ${DJANGO_DIRECTORY} # Change to directory that houses the "manage.py" file python3 manage.py runserver 0.0.0.0:8000 # Run the server as normal # Press both (ctrl + a) keys # Press "d" to disconnect from "screen" # Now we're back in the old Terminal that we know and love # If you'd like to reconnect to the most recently opened "screen", type the below screen -r # Connects to screen again