{"type":"doc","content":[{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"style":{"value":"none"}},"macroMetadata":{"macroId":{"value":"5842a0d3-ea5b-4687-a424-5f880a81b2c7"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"48718314-40da-4817-baaa-b91e3d79d7f2"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Initialize the Django Project","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create a gitlab repo","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a blank git project on a gitlab server that will hold the django project. It is helpful to have this git repo created prior to initializing the project, so that the django project can be created directly into the repo instead of having to initialize and link the git repo after the django project is created, which tends to be more difficult.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Start the dev environment","type":"text"}]},{"type":"paragraph","content":[{"text":"To start the project, we need an environment that is setup for developing django projects. It is recommended to have a Docker container specifically for this purpose. Note that we are not going to run the django project from this container. This container is only for starting up the project.","type":"text"}]},{"type":"paragraph","content":[{"text":"The ece-li-scheduling-docker git repo contains a Dockerfile called ","type":"text"},{"text":"Dockerfile.django-dev.001","type":"text","marks":[{"type":"code"}]},{"text":" to build such an environment.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter the dev environment:","type":"text"}]},{"type":"codeBlock","content":[{"text":"docker exec -it dev-env-1 /bin/bash","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to the ","type":"text"},{"text":"/opt","type":"text","marks":[{"type":"code"}]},{"text":" folder.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Clone the repo","type":"text"}]},{"type":"paragraph","content":[{"text":"Now, we are going to clone the git repo using an access token. This is assuming that the project is on a gitlab server.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create the access token.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to the gitlab repo web page.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Under ","type":"text"},{"text":"Settings ","type":"text","marks":[{"type":"strong"}]},{"text":"(left sidebar), select ","type":"text"},{"text":"Access tokens","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"Token name","type":"text","marks":[{"type":"strong"}]},{"text":" field, enter ","type":"text"},{"text":"initialize project","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For the ","type":"text"},{"text":"Expiration date","type":"text","marks":[{"type":"strong"}]},{"text":" field, the default value should be sufficient, as this git clone won’t be needed after the project is initialized.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"For the ","type":"text"},{"text":"Select a role","type":"text","marks":[{"type":"strong"}]},{"text":" dropdown, select ","type":"text"},{"text":"Developer","type":"text","marks":[{"type":"strong"}]},{"text":". This is to permit the clone to write to the repo.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"It should be unnecessary to select any of the ","type":"text"},{"text":"scopes","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the ","type":"text"},{"text":"Create project access token","type":"text","marks":[{"type":"strong"}]},{"text":" button.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"A green field will appear with the project access token hidden. Click the ","type":"text"},{"text":"Copy project access token","type":"text","marks":[{"type":"strong"}]},{"text":" button, next to the eye (reveal) button to copy the token to the clipboard.","type":"text"}]}]}]}]}]},{"type":"mediaSingle","attrs":{"layout":"center","width":760,"widthType":"pixel"},"content":[{"type":"media","attrs":{"width":1267,"id":"c3282074-985b-4110-873d-1f96d32f5a96","collection":"contentId-44434391044","type":"file","height":338},"marks":[{"type":"border","attrs":{"size":2,"color":"#091e4224"}}]}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clone the git repo.","type":"text"}]},{"type":"codeBlock","content":[{"text":"git clone https://@","type":"text"}]},{"type":"paragraph","content":[{"text":"For example,","type":"text"}]},{"type":"codeBlock","content":[{"text":"git clone https://glpat-xYzCB3sMjfFYz5Q6hyH2@git.uwaterloo.ca/d24lau/ece-li-scheduling.git","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You will be prompted to enter a password. Enter the project access token as the password.","type":"text"}]}]}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Configure git","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go into the project folder that was created when the repo was cloned.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ","type":"text"},{"text":"user.email","type":"text","marks":[{"type":"code"}]},{"text":" and ","type":"text"},{"text":"user.name","type":"text","marks":[{"type":"code"}]},{"text":" git parameters.","type":"text"}]},{"type":"codeBlock","content":[{"text":"git config --global user.email \"you@example.com\"\ngit config --global user.name \"Your Name\"","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Initialize the project","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go into the project folder that was created when the repo was cloned.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Start the project. Be sure to enter the ","type":"text"},{"text":".","type":"text","marks":[{"type":"code"}]},{"text":" at the end of the command line in order to create the project in the current folder. Otherwise, django will create a subfolder with the project name and place it one level down.","type":"text"}]},{"type":"codeBlock","content":[{"text":"django-admin startproject .","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Set the ALLOWED_HOSTS setting in the ","type":"text"},{"text":"settings.py","type":"text","marks":[{"type":"code"}]},{"text":" file. For example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"ALLOWED_HOSTS = [\"ece-li-scheduling-2.eng.uwaterloo.ca\", \"localhost\", \"127.0.0.1\"]","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optional - add a ","type":"text"},{"text":".gitignore","type":"text","marks":[{"type":"code"}]},{"text":" file to the root project directory. Add the file ","type":"text"},{"text":"db.sqlite3","type":"text","marks":[{"type":"code"}]},{"text":" to this ","type":"text"},{"text":".gitignore","type":"text","marks":[{"type":"code"}]},{"text":" file so that the SQLite database does not get stored in the git repo.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Push first commit","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create new branch ","type":"text"},{"text":"initialize","type":"text","marks":[{"type":"code"}]},{"text":". The project access token is not permitted to push to ","type":"text"},{"text":"main","type":"text","marks":[{"type":"code"}]},{"text":" branch.","type":"text"}]},{"type":"codeBlock","content":[{"text":"git branch initialize\ngit checkout initialize\ngit push --set-upstream origin initialize","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Commit the initial files created by django for the project.","type":"text"}]},{"type":"codeBlock","content":[{"text":"git add .\ngit commit -m \"Initialize django project.\"\ngit push","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Merge the ","type":"text"},{"text":"initialize","type":"text","marks":[{"type":"code"}]},{"text":" branch into ","type":"text"},{"text":"main","type":"text","marks":[{"type":"code"}]},{"text":" branch.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Build Run-time Environment","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create a gitlab repo","type":"text"}]},{"type":"paragraph","content":[{"text":"Create a blank git project on a gitlab server that will hold the Dockerfiles for building the run-time container.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create deploy key","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"From the Dockerfile repo:","type":"text"}]},{"type":"codeBlock","content":[{"text":"ssh-keygen -t rsa -b 4096 -f /path/to/desired/filename -N \"\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Commit and push the repo.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"On the gitlab repo web page, go to ","type":"text"},{"text":"Settings","type":"text","marks":[{"type":"strong"}]},{"text":" → ","type":"text"},{"text":"Repository","type":"text","marks":[{"type":"strong"}]},{"text":".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Expand the ","type":"text"},{"text":"Deploy key","type":"text","marks":[{"type":"strong"}]},{"text":"s section.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Click the ","type":"text"},{"text":"Add new key","type":"text","marks":[{"type":"strong"}]},{"text":" button.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Enter the ","type":"text"},{"text":"Title","type":"text","marks":[{"type":"strong"}]},{"text":" field (e.g. ","type":"text"},{"text":"Run-time environment","type":"text","marks":[{"type":"code"}]},{"text":").","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy and paste the contents of the SSH key ","type":"text"},{"text":".pub","type":"text","marks":[{"type":"code"}]},{"text":" file into the ","type":"text"},{"text":"Key","type":"text","marks":[{"type":"strong"}]},{"text":" field.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Depending on whether or not you wish to develop in another environment and only deploy to the run-time environment, or whether you wish to use the container to make changes to the codebase, select whether or not to grant write privileges to the deploy key.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create Dockerfile","type":"text"}]},{"type":"paragraph","content":[{"text":"Add the deploy key to the container and setup the key inside the container.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The main steps for the Dockerfile are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a ","type":"text"},{"text":".ssh","type":"text","marks":[{"type":"code"}]},{"text":" folder.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy the deploy key into the ","type":"text"},{"text":".ssh","type":"text","marks":[{"type":"code"}]},{"text":" folder.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add gitlab server to ","type":"text"},{"text":"known_hosts","type":"text","marks":[{"type":"code"}]},{"text":" file.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Setup ","type":"text"},{"text":".ssh/config","type":"text","marks":[{"type":"code"}]},{"text":" file to explicitly specify the deploy key and username to be used.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Clone the repo.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Here is some example Dockerfile code.","type":"text"}]},{"type":"codeBlock","content":[{"text":"RUN mkdir -p /root/.ssh && chmod 700 /root/.ssh\nADD id_rsa_ece_li_scheduling_deploy /root/.ssh/id_rsa_ece_li_scheduling_deploy\nRUN chmod 600 /root/.ssh/id_rsa_ece_li_scheduling_deploy\nRUN ssh-keyscan -H git.uwaterloo.ca >> /root/.ssh/known_hosts\n\nRUN echo \"Host git.uwaterloo.ca\\n\\\n HostName git.uwaterloo.ca\\n\\\n IdentityFile /root/.ssh/id_rsa_ece_li_scheduling_deploy\\n\\\n StrictHostKeyChecking no\\n\\\n User ist-git\" >> /root/.ssh/config\nRUN chmod 600 /root/.ssh/config\n\nRUN git clone ist-git@git.uwaterloo.ca:d24lau/ece_li_scheduling.git\n","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Docker build and run","type":"text"}]},{"type":"paragraph","content":[{"text":"At this stage, you should be able to use a browser to test that the Django server is up and running. Go to ","type":"text"},{"text":"http://:8000","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Setup Docker Volume","type":"text"}]},{"type":"paragraph","content":[{"text":"A Docker volume is the preferred way of storing state information for the Docker container. For example, the ","type":"text"},{"text":"db.sqlite3","type":"text","marks":[{"type":"code"}]},{"text":" file is best stored on a Docker volume, so that it can be referenced by any container. Therefore, as the Django project codebase develops, each version of the container can use the same data store.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To create the Docker volume, on the host:","type":"text"}]},{"type":"codeBlock","content":[{"text":"docker volume create ","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"When running the container, the volume is mounted using the ","type":"text"},{"text":"-v","type":"text","marks":[{"type":"code"}]},{"text":" switch. The syntax for this switch is:","type":"text"}]},{"type":"codeBlock","content":[{"text":"-v :","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Establishing database file","type":"text"}]},{"type":"paragraph","content":[{"text":"After the first time ","type":"text"},{"text":"python3 manage.py migrate","type":"text","marks":[{"type":"code"}]},{"text":" has been run,","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Transfer the ","type":"text"},{"text":"db.sqlite3","type":"text","marks":[{"type":"code"}]},{"text":" file to the mounted volume.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Delete the ","type":"text"},{"text":"db.sqlite3","type":"text","marks":[{"type":"code"}]},{"text":" file from its default location at the project root folder.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a symlink at the project root folder called ","type":"text"},{"text":"db.sqlite3","type":"text","marks":[{"type":"code"}]},{"text":" that points to the file on the mounted volume.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Database connection using entrypoint.sh","type":"text"}]},{"type":"paragraph","content":[{"text":"It is recommended that the ","type":"text"},{"text":"entrypoint.sh","type":"text","marks":[{"type":"code"}]},{"text":" script is used to establish the database connection. The general sequence in the ","type":"text"},{"text":"entrypoint.sh","type":"text","marks":[{"type":"code"}]},{"text":" script to connect the database on the volume is:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Run ","type":"text"},{"text":"makemigrations","type":"text","marks":[{"type":"code"}]},{"text":"/ ","type":"text"},{"text":"migrate","type":"text","marks":[{"type":"code"}]},{"text":". This creates a ","type":"text"},{"text":"db.sqlite3","type":"text","marks":[{"type":"code"}]},{"text":" database file in its default location in the project root folder.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Delete the ","type":"text"},{"text":"db.sqlite3","type":"text","marks":[{"type":"code"}]},{"text":" file from the project root folder.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a symlink to the database folder.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"Here is an example of an ","type":"text"},{"text":"entrypoint.sh","type":"text","marks":[{"type":"code"}]},{"text":" script:","type":"text"}]},{"type":"codeBlock","content":[{"text":"#!/bin/bash\n\n# Ensure the log directory exists\nmkdir -p /var/log/django\n\n# Redirect stdout and stderr to the log file\nexec >> /var/log/django/entrypoint.log 2>&1\n\npython3 manage.py makemigrations\npython3 manage.py migrate\n\nrm /opt/ece_li_scheduling/db.sqlite3\nln -s /var/lib/ece_li_scheduling/db.sqlite3 /opt/ece_li_scheduling/db.sqlite3\n\npython3 manage.py runserver 0.0.0.0:8000","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Start First App","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Navigate to the root directory of the Django project (where the ","type":"text"},{"text":"manage.py","type":"text","marks":[{"type":"code"}]},{"text":" file is located).","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Use ","type":"text"},{"text":"manage.py","type":"text","marks":[{"type":"code"}]},{"text":" to initialize the app:","type":"text"}]},{"type":"codeBlock","content":[{"text":"python3 manage.py startapp ","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Register app","type":"text"}]},{"type":"paragraph","content":[{"text":"Register the app with the project.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Go to the project folder (e.g. ","type":"text"},{"text":"/opt/ece_li_scheduling/ece_li_scheduling","type":"text","marks":[{"type":"code"}]},{"text":") where the ","type":"text"},{"text":"settings.py","type":"text","marks":[{"type":"code"}]},{"text":" file is stored.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"settings.py","type":"text","marks":[{"type":"code"}]},{"text":" file, add the name of the new app to the ","type":"text"},{"text":"INSTALLED_APPS","type":"text","marks":[{"type":"code"}]},{"text":" list:","type":"text"}]},{"type":"codeBlock","content":[{"text":"INSTALLED_APPS = [\n 'django.contrib.admin',\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.messages',\n 'django.contrib.staticfiles',\n '',\n]","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"In the ","type":"text"},{"text":"urls.py","type":"text","marks":[{"type":"code"}]},{"text":" file, direct all traffic for the new app to its ","type":"text"},{"text":".urls","type":"text","marks":[{"type":"code"}]},{"text":" file.","type":"text"}]},{"type":"codeBlock","content":[{"text":"urlpatterns = [\n path('admin/', admin.site.urls),\n path('/', include('.urls'))\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that ","type":"text"},{"text":"include","type":"text","marks":[{"type":"code"}]},{"text":" needs to be imported from ","type":"text"},{"text":"django.urls","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create urls.py","type":"text"}]},{"type":"paragraph","content":[{"text":"Since the project ","type":"text"},{"text":"urls.py","type":"text","marks":[{"type":"code"}]},{"text":" directs traffic to the app, the app needs to handle this traffic with its own ","type":"text"},{"text":"urls.py","type":"text","marks":[{"type":"code"}]},{"text":" file.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a ","type":"text"},{"text":"urls.py","type":"text","marks":[{"type":"code"}]},{"text":" file within the app folder. Here is an example,","type":"text"}]},{"type":"codeBlock","content":[{"text":"from django.urls import path\nfrom . import views\n\nurlpatterns = [\n path('', views.home, name='home'),\n]","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that this example points to a ","type":"text"},{"text":"home","type":"text","marks":[{"type":"code"}]},{"text":" function in the app views, but this has not been created yet.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Create view","type":"text"}]},{"type":"paragraph","content":[{"text":"The app needs at least one view.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Add a function to the app ","type":"text"},{"text":"views.py","type":"text","marks":[{"type":"code"}]},{"text":" file with a name that matches the function name specified in the ","type":"text"},{"text":"urls.py","type":"text","marks":[{"type":"code"}]},{"text":" file. Here is an example,","type":"text"}]},{"type":"codeBlock","content":[{"text":"from django.http import HttpResponse\n\ndef home(request):\n return HttpResponse(\"Hello, World!\")","type":"text"}]}]}]},{"type":"paragraph"},{"type":"paragraph"},{"type":"paragraph"}],"version":1}

Browser not supported