https://github.com/kenanbek/django-rest-skeleton

Django and REST Framework skeleton project.
https://github.com/kenanbek/django-rest-skeleton

django django-rest-framework docker docker-compose dockerfile postgres postgresql python rest rest-api

Last synced: 28 days ago
JSON representation

Django and REST Framework skeleton project.

• Host: GitHub
• URL: https://github.com/kenanbek/django-rest-skeleton
• Owner: KenanBek
• License: apache-2.0
• Created: 2018-03-10T16:58:15.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T00:55:11.000Z (almost 2 years ago)
• Last Synced: 2024-05-02T04:29:03.995Z (7 months ago)
• Topics: django, django-rest-framework, docker, docker-compose, dockerfile, postgres, postgresql, python, rest, rest-api
• Language: Python
• Homepage:
• Size: 33.2 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Django REST Framework skeleton

Django and REST Framework skeleton project.

## Versions

App | Version

--- | ---

Python | 2.7.12

Django | 1.11.11

DRF | 3.7.7

## What is included

- Preconfigured demo endpoints

- PostgreSQL as a Django database

- Scalable Docker and Docker Compose configuration (HAProxy)

## Docker Compose containers

- db (Django PostgreSQL database)

- web (Django application)

- lb (HAProxy load balancer)

# Project structure

    django-rest-skeleton/

    |---src                                     # django project folder

    |   |---drs                                 # django root configuration

    |   |   |---settings.py

    |   |   |---urls.py

    |   |   |---wsgi.py

    |   |---files

    |   |   |---tempaltes                       # view templates

    |   |   |   |---index.html

    |   |   |---media                           # images, sized cache and placeholder

    |   |   |   |---.gitignore

    |   |   |   |---placeholder.png

    |   |   |   |---README.md

    |   |   |---static

    |   |   |   |---placeholder.png

    |   |   |---README.md

    |   |---manage.py

    |---.gitignore

    |---.dockerignore

    |---Vagrantfile

    |---Dockerfile

    |---docker-compose.yml

    |---requirements.txt

    |---README.md

# Setup & Run

## Copy git repository

    # Clone repository

    git clone https://github.com/KenanBek/django-rest-skeleton.git

    # Move to project's folder

    cd django-rest-skeleton

## Run on docker

    # build docker containers

    docker-compose build

    # option 1: run 1 instance of web

    docker-compose up

    # option 2: run 3 instances of web over load balancer

    docker-compose up --scale web=3

    

    # option 3: run in background with -d

    docker-compose up -d --scale web=3

You can also run manage.py commands using docker environment, for example tests.

    docker-compose run web python ./manage.py test

See docker's logs

    docker-compose logs --tail 5

## Run on local machine

    pip install -r requirements.txt

    cd src

    python manage.py runserver