basic-CRUD-api

Django & Django REST Framework

Folder structure

.
├── CRUD_api
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py
│   ├── urls.py
│   └── wsgi.py
├── myapi
│   ├── migrations
│   │   └── __init__.py
│   ├── __init__.py
│   ├── admin.py
│   ├── apps.py
│   ├── models.py
│   ├── serializers.py
│   ├── tests.py
│   └── views.py
├── .gitignore
├── manage.py
├── README.md
└── requirements.txt

• The CRUD_api/ folder is only a container for the project, you can change its name.
• The CRUD_api/ folder is the actual Python package for your project.
• The myapi/ folder is the Python package containing the users & groups api application that has its root mapped to the /users & /groups URL.
• manage.py is a command-line utility that helps you to interact with the project.

Setup

Make sure you have python3 installed in your machine before you continue. For windows users, the path to python3 must be added to the system environment variable PATH.

Install virtualenv in python.

pip3 install virtualenv

Create a virtual environment

Linux

$ virtualenv -p python3 venv

This will create a virtual environment named venv with python3 as its interpreter.

Windows

If you have multiple versions of python installed and added to PATH, find out the path for python3.

> where python
C:\Python27\python.exe
C:\Users\San\AppData\Local\Programs\Python\Python37-32\python.exe
C:\Users\San\AppData\Local\Programs\Python\Python36\python.exe

You will get an output of all the python execuables that are added to PATH. For example I have python2.7, python3.6 and python3.7 installed.

In this command, the path to python3.6 is being used to create the virtual environment.

> virtualenv -p C:\Users\San\AppData\Local\Programs\Python\Python36\python.exe venv

Activating the virtualenv

Linux

$ source venv/bin/activate
(venv) ...$ 

Windows

> venv\Scripts\activate
(venv) ...> 

Installing requirements

You can install the requirements for this project from the requirements.txt file by using the command

(venv) ...$ pip install -r requirements.txt

Since you're inside a virtualenv, the requirements will be installed inside it, keeping the project requirements specific to the project.

Running the Applcation

Django comes with a lightweight development server. You can run it with the following command:

$ 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 admin.0003_logentry_add_action_flag_choices... 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 auth.0010_alter_group_name_max_length... OK
  Applying auth.0011_update_proxy_permissions... OK
  Applying auth.0012_alter_user_first_name_max_length... OK
  Applying sessions.0001_initial... OK

$ python manage.py runserver
Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).
September 29, 2020 - 16:12:25
Django version 3.1, using settings 'hello_world.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.

Important: This is a development serever, it's only goal is to speed up the development. Please use a production web server for your production environment.

Viewing the application in a web browser

Open up a web browser and navigate to

http://127.0.0.1:8000/

Or, click here to do the same.