hemp-db

File Structure

This page outlines the file structure used for the HempDB project and is intended for developers and maintainers.

hemp-db/
├─ .github/
├─ docs/
│  └─ images/
├─ hempdb/
└─ helloworld/
   ├─ management/
   │  └─ commands/
   ├─ migrations/
   └─ templates/

A high-level folder structure of hemp-db.

.github/

• Files related to GitHub Actions workflows and GitHub Issue templates.

docs/

• Markdown files and images for this documentation site.

hempdb/

• The Django “project” containing high-level configuration files like settings.py and the top-level urls.py.

helloworld/

• The Django “app” containing a majority of the project’s code. Notable folders/files include:
  • migrations/: files that track changes made to database schema. Documentation here.
  • templates/: files that construct the frontend interface using Django’s templating syntax to dynamically insert content. Documentation here.
  • admin.py: configuration for the Django admin portal. Documentation here.
  • forms.py: form definitions that are used on the frontend. Documentation here.
  • models.py: database schema and table (model) definitions. Documentation here.
  • signals.py: code for Django’s signal dispatcher to be run when certain events occur. Documentation here.
  • tests.py: tests run on GitHub Actions. Documentation here.
  • urls.py: maps different URL paths corresponding views. Documentation here.
  • views.py: handles HTTP requests by typically querying the database, performing business logic, and responding with templates and corresponding data. Documentation here.

This site is open source. Improve this page.