Notes/docs/Guides/Django REST Framework/1 - Setup.md

3.4 KiB

Overview

Django is a framework built with Python to help you implement web applications.

353e9c415078b3d4a18d7bd93294df1c_MD5

8d193fcb83f676cd16e263f78f965bc5_MD5

Django can be used as-is to develop full stack web apps which include your frontend and backend. This however isn't the focus of this guide.

You will be using Django alongside Django REST Framework to instead build a backend API, which will only serve data from your database, and not serve as a frontend framework. This guide will focus on data, so no fancy frontend design stuff!

This guide has concepts that are similar to the official guide for Django linked here. Check it out as well!

Getting Started

You will need to install the latest version of Python (version 3.11.2 as of 2/19/2023)

https://www.python.org/downloads/

During the installation, make sure to check Add Python 3.x to PATH

373ea207d1abd6f0a734506d8ab4acbc_MD5

To check if you have a working install, open a command line (CMD) and type in python --version

5d1081e556bd19260f14a235fef4e383_MD5

If this does not work, you will have to check your PATH variables. If it does, you can safely proceed to the next step.

3ed75d2e3ff3aad581b4cd7c2af748a3_MD5

aef7461456894804006fa820f6a2061e_MD5

Install Pipenv

When working with Python projects, you will have multiple dependencies.

One of your Python projects may require these package versions

whitenoise==6.6.0
gunicorn==22.0.0

While another might require an older version

whitenoise==5.6.0
gunicorn==21.0.0

Managing dependencies in a single installation is a nightmare you definitely don't want to deal with. Using Pipenv, or other alternatives like Python venv (which is not discussed in this guide) will help you avoid these issues.

Open up a command line (CMD) and type in pip install --user pipenv to install Pipenv

This will use the package manager for Python (akin to npm for Javascript/Typescript projects) to install the Pipenv package

8e0864b9971e3e0ec0843db1494a9164_MD5

Install Git

When developing applications, you will need to use version control to track changes.

Head over to the downloads page and install the 64-bit Git for Windows Setup version (Standalone Installer)

c2f115b66c9b0f4e93ea54d1091f9696_MD5 This guide does not cover the proper usage of Git and so you may need to look up for other resources if you are not familiar with it yet.

6198958f0bad6ed532a840df3435ad23_MD5 You can proceed with the typical installation using defaults (no need to change anything), just click Next/Install.

With that out of the way, you can proceed to setting up your Django REST Framework project.