https://github.com/ukjin1192/django-rest-framework-example

REST framework example for Django < 1.9 // New version ->
https://github.com/ukjin1192/django-rest-framework-example

django django-rest-framework

Last synced: about 2 months ago
JSON representation

REST framework example for Django < 1.9 // New version ->

• Host: GitHub
• URL: https://github.com/ukjin1192/django-rest-framework-example
• Owner: ukjin1192
• Created: 2015-12-08T05:35:54.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-07T23:33:26.000Z (over 3 years ago)
• Last Synced: 2023-03-01T18:20:57.352Z (almost 2 years ago)
• Topics: django, django-rest-framework
• Language: Python
• Homepage: https://github.com/ukjin1192/django-rest-framework-sample
• Size: 270 KB
• Stars: 30
• Watchers: 1
• Forks: 4
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Django REST framework example

## Stack

#### Back-end

- Nginx : Web server

- uWSGI : Connect web server and application server

- Django REST framework (v3.2) : Application server

- MySQL : Relational DB

- Redis : In-memory DB

- Celery : Async task manager

- Fabric : Deploy tool

#### Front-end

- NPM : Package management

- Webpack : Manage static files and bundle modules

- SCSS : Stylesheet

- Bootstrap : Framework made by twitter

#### Django framework libraries

- django-simple-captcha : Human validation

- django-suit : Admin interface

- django-silk : Inspection tool 

- REST framework JWT : JSON Web Token authentication

## Models & Permissions

#### User : User profile which extends default user class

- List : admin only

- Create : anyone

- Retrieve : own self or admin

- Update : own self or admin

- Partial update : own self or admin

- Destroy : admin only

#### Article : Article written by user 

- List : anyone

- Create : logged in user

- Retrieve : anyone

- Update : own self only

- Partial update : own self only

- Destroy : admin only

#### Comment : Comment under specific article

- List : anyone

- Create : logged in user

- Retrieve : anyone

- Update : own self only

- Partial update : own self only

- Destroy : admin only

## Directory structure

	


	/var/www/mysite.com/

		.gitignore

		manage.py

		fabfile.py

		robots.txt

		package.json

		conf/

			nginx/

				nginx.dev.conf

				nginx.prod.conf

			uwsgi/

				mysite.ini

				uwsgi.conf

			pip/

				requirements.txt

			sensitive-fake/

				configuration.ini

				remote_server.pem

		logs/

		mysite/

			__init__.py

			urls.py

			wsgi.py

			apps/

				main/

					__init__.py

					admin.py

					models.py

					permissions.py

					seliarizers.py

					tests.py

					urls.py

					views.py

				utils/

					__init__.py

					cron.py

					redis.py

					utilities.py

			settings/

				__init__.py

				base.py

				dev.py

				prod.py

			templates/

				base.html

				index.html

				404.html

				503.html

			static/

				index.js

				webpack.config.js

				styles.scss

				bootstrap.config.js

				bootstrap.config.less

				module/

					obtainAuthToken.js

					verifyAuthToken.js

					setAuthToken.js

					refreshAuthToken.js

					clearAuthToken.js



## Installation

- Ubuntu basic settings

- Django basic settings

- NPM basic settings

- Webpack basic settings

- SCSS basic settings

## Customization

#### Rename project and configure basic settings

~~~~

$ mv django-rest-framework-example/ /var/www/{YOUR PROJECT NAME}.com/

$ cd /var/www/{YOUR PROJECT NAME}.com/

$ mv mysite/ {YOUR PROJECT NAME}/

~~~~

- Let `{PROJECT PATH}` as `/var/www/{YOUR PROJECT NAME}.com/`

~~~~

$ cd {PROJECT PATH}/conf/uwsgi/

$ mv mysite.ini {YOUR PROJECT NAME}.ini

$ vi {YOUR PROJECT NAME}.ini

	:%s/mysite/{YOUR PROJECT NAME}/g

$ cd {PROJECT PATH}/conf/nginx/

$ vi nginx.dev.conf nginx.prod.conf

	:%s/mysite/{YOUR PROJECT NAME}/g

~~~~

-	Edit value of `worker_processes` to `grep processor /proc/cpuinfo | wc -l`

-	Edit value of `worker_connections` to `ulimit -n`

-	Commentify `Redirect HTTP to HTTPS` block if you will not use SSL

-	Commentify `Redirect www to non-www` block if you will not redirect `www` to `non-www`

~~~~

$ cd {PROJECT PATH}/

$ vi package.json [Edit input]

	:%s/mysite/{YOUR PROJECT NAME}/g

~~~~

#### Fill out sensitive data

~~~~

$ cd {PROJECT PATH}/conf/

$ cp -R sensitive-data/ sensitive/

$ vi configuration.ini [Fill out variables]

$ vi remote_server.pem [Fill out public certificate of remote server]

~~~~