Your first Django project!

Part of this chapter is based on tutorials by Django Girls Tutorial : https://tutorial.djangogirls.org

Some other notes before we begin:-

We are going to create a starting page welcoming the player, initially will be directed to a room with two doors to start the adventure.
Later on, when we start implementing forms, we will ask player to enter their name on the starting page before we begin the adventure.

The first step is to start a new Django project. Basically, this means that we'll run some scripts provided by Django that will create the skeleton of a Django project for us. This is just a bunch of directories and files that we will use later.

The names of some files and directories are very important for Django. You should not rename the files that we are about to create. Moving them to a different place is also not a good idea. Django needs to maintain a certain structure to be able to find important things.

Remember to run everything in the virtualenv. If you don't see a prefix (myvenv) in your console, you need to activate your virtualenv. We explained how to do that in the Django installation chapter in the Working with virtualenv part.

On Windows, type the following:
C:\> myvenv\Scripts\activate
On Mac OS X or Linus, type the following:

$source myvenv/bin/activate

Create project: OS X or Linux

In your Mac OS X or Linux console, you should run the following command.

Don't forget to add the period (or dot) . at the end!

(myvenv) ~/textbasedgame $ django-admin startproject tbgsite .

The period.is crucial because it tells the script to install Django in your current directory (for which the period.is a short-hand reference).

Note: When typing the command above, remember that you only type the part which starts bydjango-admin. The(myvenv) ~/textbasedgame $part shown here is just example of the prompt that will be inviting your input on your command line.

Create project: Windows

On Windows you should run the following command. (Don't forget to add the period (or dot) . at the end):

(myvenv) C:\Users\Name\textbasedgame> django-admin.exe startproject tbgsite .

The period.is crucial because it tells the script to install Django in your current directory (for which the period.is a short-hand reference).

NoteWhen typing the command above, remember that you only type the part which starts bydjango-admin.exe. The(myvenv) C:\Users\Name\djangogirls>part shown here is just example of the prompt that will be inviting your input on your command line.

django-admin.py is a script that will create the directories and files for you. You should now have a directory structure which looks like this:

tbgsite
├───manage.py
└───mysite
        settings.py
        urls.py
        wsgi.py
        __init__.py

Note: in your directory structure, you will also see your venv directory that we created before.

manage.py is a script that helps with management of the site. With it we will be able (amongst other things) to start a web server on our computer without installing anything else.

Thesettings.pyfile contains the configuration of your website.

urls.py file contains a list of patterns used by urlresolver .

Let's ignore the other files for now as we won't change them. The only thing to remember is not to delete them by accident!

Changing settings

Let's make some changes intbgsite/settings.py. Open the file using the code editor you installed earlier.

Note: Keep in mind thatsettings.pyis a regular file, like any other. You can open it from inside the code editor, using the "file -> open" menu actions. This should get you the usual window in which you can navigate to yoursettings.pyfile and select it. Alternatively, you can open the file by navigating to the djangogirls folder on your desktop and right-clicking on it. Then, select your code editor from the list. Selecting the editor is important as you might have other programs installed that can open the file but will not let you edit it.

It would be nice to have the correct time on our website. Go to Wikipedia's list of time zones and copy your relevant time zone (TZ) (e.g.Europe/Dublin).

In settings.py, find the line that contains TIME_ZONEand modify it to choose your own timezone.

For example in tbgsite/settings.py :

TIME_ZONE = 'Europe/Dublin'

A language code consist of the language, e.g.enfor english ordefor german, and the country code, e.g.defor germany orchfor switzerland. You will want to add this if you want the default buttons and notifications from Django to be in your language. So you would have "Cancel" button translated into the language you defined here.Django comes with a lot of prepared translations.

Change the language code by changing the following line in tbgsite/settings.py:

LANGUAGE_CODE = 'en-ie'

We'll also need to add a path for static files. (We'll find out all about static files and CSS later in the tutorial.) Go down to the _end _of the file, and just underneath the STATIC_URL entry, add a new one called STATIC_ROOTin tbgsite/settings.py:

STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'static')

When DEBUG is True and ALLOWED_HOSTS is empty, the host is validated against ['localhost', '127.0.0.1', '[::1]'].

Set up a database

There's a lot of different database software that can store data for your site. We'll use the default one,sqlite3.

This is already set up in this part of yourtbgsite/settings.pyfile:

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

To create a database for our blog, let's run the following in the console:

$ python manage.py migrate

(we need to be in the textbasedgamedirectory that contains the manage.py file). If that goes well, you should see something like this:

(myvenv) ~/textbasedgame$ python manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, contenttypes, sessions
Running migrations:
  Applying contenttypes.0001_initial... OK
  Applying auth.0001_initial... OK
  Applying admin.0001_initial... OK
  Applying admin.0002_logentry_remove_auto_add... OK
  Applying contenttypes.0002_remove_content_type_name... OK
  Applying auth.0002_alter_permission_name_max_length... OK
  Applying auth.0003_alter_user_email_max_length... OK
  Applying auth.0004_alter_user_username_opts... OK
  Applying auth.0005_alter_user_last_login_null... OK
  Applying auth.0006_require_contenttypes_0002... OK
  Applying auth.0007_alter_validators_add_error_messages... OK
  Applying auth.0008_alter_user_username_max_length... OK
  Applying auth.0009_alter_user_last_name_max_length... OK
  Applying sessions.0001_initial... OK

And we're done! Time to start the web server and see if our website is working!

Starting the web server

You need to be in the directory that contains the manage.py

file (the djangogirls directory). In the console, we can start the web server by running python manage.py runserver:

(myvenv) ~/textbasedgame$ python manage.py runserver

You will also see this output in your console after you runserver:

Performing system checks...

System check identified no issues (0 silenced).
January 19, 2018 - 16:28:00
Django version 2.0.1, using settings 'tbgsite.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

On Windows and this fails with UnicodeDecodeError, use this command instead:
(myvenv) ~/textbasedgame$ python manage.py runserver 0:8000

Now all you need to do is check that your website is running. Open your browser (Firefox, Chrome, Safari, Internet Explorer or whatever you use) and enter this address:

http://127.0.0.1:8000/

If you see the following...

🙌 Congratulations! You've just created your first Django site and run it using a web server! Isn't that awesome?

While the web server is running, you won't see a new command-line prompt to enter additional commands. The terminal will accept new text but will not execute new commands. This is because the web server continuously runs in order to listen for incoming requests.

To type additional commands while the web server is running, open a new terminal window and activate your virtualenv. To stop the web server, switch back to the window in which it's running and press CTRL+C - Control and C keys together (on Windows, you might have to press Ctrl+Break).

Ready for the next step? It's time to create some content!

Creating your first Django project