Skip to content

Design Notes

Jump to bottom
Jeremy Satterfield edited this page Sep 23, 2018 · 2 revisions

App structure

  • Code Stack
    • Python 3.7
    • Django
    • Django REST Framework
    • Custom interface via (jinja?) templates
    • API for other systems to communicate
  • Infrastructure
    • Hosted in space, public on static ip
    • Nginx to route this and other apps
    • Let's encrypt for SSL
  • Physical identification
    • Identifier (tool pk?) printed and placed on tool and shelf
    • QR code with url to view tool

Models

  • User
    • Let's start with a Custom user now, even if we don't have extra fields yet. We'll be glad we did
  • Tool
    • Owner
    • Description
    • Photos
    • Guideline tagging plus free-form "other"
    • Nested Category tagging (https://github.com/radiac/django-tagulous)
    • Storage location
    • Clearance requirement - None, owner, any cleared user
    • notify owner of borrow
  • History of usage
    • tool
    • borrower
    • timestart borrowed
    • timestamp returned
  • Clearance for tool usage
    • tool
    • user

Pages

  • Tool search
  • tool details
    • Tool model fields
    • Checkout status w/ borrower
    • checkout history - last 5? all?
  • User details
    • user info
    • tools owned (w/ checkout status)
    • tools currently borrowed
Clone this wiki locally