Skip to content

Django server for Neighborly, a peer-to-peer commodity sharing application.

Notifications You must be signed in to change notification settings

heymonicakay/neighborlyserver

Repository files navigation

Neighborly

... serve it up!

Learning Goals

  • Use Django Models and the ORM to write more specific queries that return precisely the data requested.
  • Build upon my knowledge of classes and inheritence by creating class based views in the Django Rest Framework.
  • Create logical responses whose content and messages are useful to the client, especially regarding errors.
  • Learn how to use Pillow to configure a Django project for image uploads.

Features

The server utilizes unmapped properties to send useful information along with the objects stored in the database, and custom actions to either send very specific data to the client, or manipulate object properties. These features allow the client to request more precise data from the server, thereby minimizing the amount of extraneous data sent back to the client and reducing — if not eliminating — the need for client side data filtering.

Set Up

  1. Clone this repo

    git clone git@github.com:heymonicakay/neighborlyserver.git
    cd neighborlyserver
    
  2. Activate virtual environment

    pipenv shell
    
  3. Install dependencies

    pipenv install
    
  4. Install Pillow

  5. Run the server

    python manage.py runserver
    
  6. Finish installation by following the instructions found here: Neighborly Client Repo

Created by Monica Kay

Monica Kay GitHub Monica Kay LinkedIn