https://github.com/sangahco/django-rest-framework

Sample Rest API Framework using Django
https://github.com/sangahco/django-rest-framework

Last synced: about 2 months ago
JSON representation

Sample Rest API Framework using Django

• Host: GitHub
• URL: https://github.com/sangahco/django-rest-framework
• Owner: sangahco
• Created: 2020-06-16T06:48:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-02-06T21:47:37.000Z (almost 2 years ago)
• Last Synced: 2024-04-16T07:52:02.807Z (8 months ago)
• Language: Python
• Size: 576 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# REST API Framework in Django

## Set up the project

Upgrade pip to the latest version:

`python -m pip install --upgrade pip`

Then we install virtualenv:

`pip install --user virtualenv`

With the next command we create a new python environment, using python version 3, so we can install the required modules without creating issues to other python applications:

`virtualenv env --python=python3`

if everything is ok you will see a new folder `env` inside the project folder.

In order to work in our new environment we need to activate it:

`source env/bin/activate`

We should see an `(env)` at the start of the command line

Now we are ready to install the required modules:

`pip install -r requirements.txt`

Before starting the application we initialize the database:

`python manage.py migrate`

We create a superuser for managing users and groups:

`python manage.py createsuperuser`

Before starting the application some configuration is required, create a new file named `local.settings.py` into the `mainapp` folder, just near the `settings.py` and add all the required variables.

Now we are ready to run the application:

    $ ./django-auto.sh

## Production

Before running the application in production, we should create a new `SECRET_KEY`, for security reason,

we can use the function `django.core.management.utils.get_random_secret_key()`.

The variable `DEBUG` should be set to `False`.

Also we need to collect the static files since django will refuse to serve static files with `DEBUG=False`; we will use the command `collectstatic` provided by django:

    $ python manage.py collectstatic --clear

A new folder `static` will be created under the project folder.

In the web server configuration we need to add the static location in order to serve those files:

    location /static/ {

        root /app;

    }