Skip to content

File Structure

Jump to bottom
Sierra Tran edited this page May 9, 2025 · 2 revisions

This page provides an overview of the main files and directories in the django-inventory_database project.

Top-Level Structure

django-inventory_database/
├── authentication/           # Custom user authentication app
├── inventory/                # Main inventory management app
├── inventory_database/       # Project configuration (settings, URLs, WSGI)
├── staticfiles/              # Collected static files for deployment
├── templates/                # (If present) Shared template files
├── .env                      # Environment variables (you have to make this file)
├── .gitignore                # Git ignore rules
├── db.sqlite3                # SQLite database (for development)
├── manage.py                 # Django management script
├── README.md                 # Project documentation
├── requirements.txt          # Python dependencies
├── deploy.bat / deploy.sh    # Scripts to run the application

Directory Details

authentication/

Contains code for user authentication and notification management. Typical files:

  • models.py: Custom user and notification models.
  • views.py: Views for login, logout, registration, notifications.
  • forms.py: Forms for authentication.
  • templates/authentication/: HTML templates for authentication pages.

inventory/

Handles inventory items, requests, purchase orders, and related logic.

  • models.py: Item, UsedItem, ItemRequest, PurchaseOrderItem models.
  • views.py: Views for listing, creating, editing, and searching items.
  • forms.py: Forms for item management and importing/exporting data.
  • templates/inventory/: HTML templates for inventory pages.

inventory_database/

Project-level configuration.

  • settings.py: Django settings (database, installed apps, middleware, etc.).
  • urls.py: URL routing for the project.
  • wsgi.py: WSGI entry point for deployment.

staticfiles/

Contains static assets (CSS, JS, images) collected for deployment. Not edited directly—managed by Django's collectstatic.

.env

Environment variables for sensitive settings (secret key, debug mode, allowed hosts). You will have to make this file.

README.md

Comprehensive documentation for setup, usage, and contributing.

requirements.txt

Lists all required Python packages and their versions.

deploy.bat / deploy.sh

Scripts to start the application on Windows or Unix-based systems.

For more details on each app or file, see the respective documentation (coming soon) or source code comments.

Clone this wiki locally