/django-rest-tutorial

A repo for walkthrough in implementing basic CRUD functionalities using Django framework.

Primary LanguagePython

Django Rest Tutorial

Django CI

This repo is just for me to keep track/practice on Django along with DRF (djangorestframework).

To-do lists:

  • Remove the current/existing setups for Windows.

  • Setup new venv for Django.

  • Create a requirements.txt to list out all the necessary Python modules.

  • Added functions-based views vs class-based views in Django.

  • Implement unit-testing for views (using APITestCase from DRF).

  • Implement DRF Router for mapping of URL with views.

  • Setup Github Actions YAML file for automating unit testing.

  • Add codecoverage tools in Github Action's workflow.

  • Setup Docker for this project.

  • Implement service layer (Based on Two Scoops of Django).

  • Change from pip to uv.

Installing

A step by step guide on how to setup your local environment/setting.

1: Create a local venv(virtualenv)

$ python3 -m venv <envName>

2: Activate the venv

$ source <envName>/bin/activate

3: Install all the modules listed within requirements.txt

$ pip install -r requirements.txt
  1. cd into tutorialProject and make manage.py file executable by:
$ chmod +x manage.py

4: To run the Django server at localhost:

$ ./manage.py runserver

5: To activate Django shell:

$ ./manage.py shell