VerdunNRP Documentation
January 5, 2025 · View on GitHub
⚠️ Archived Project Notice: This is an archived project that will not receive further updates. This documentation serves as a reference for understanding the project's architecture and implementation.
Table of Contents
Project Overview
VerdunNRP is a Django-based Network Resource Planning system designed to manage complex economic interactions. The system handles equipment management, resource tracking, and value network operations.
Architecture
Core Components
-
Equipment Module
- Manages equipment inventory and usage
- Handles usage logging and payment processing
- Tracks maintenance and repairs
-
Resource Module
- Manages resource types and inventory
- Tracks resource movements and transfers
- Calculates resource values
-
Board Module
- Manages workflows and processes
- Tracks resource allocation
- Handles stage progression
Technology Stack
- Backend: Django 3.2+
- Database: PostgreSQL
- Cache: Redis
- API: RESTful with token authentication
Security
- Token-based authentication
- Role-based access control
- CSRF protection
- Session management
Technical Documentation
Detailed technical documentation is split into two main sections:
-
API Reference - Complete API documentation
- Authentication
- Endpoints
- Request/Response formats
- Error handling
-
Database Schema - Database documentation
- Table structures
- Relationships
- Common queries
System Requirements
- Python 3.9+
- PostgreSQL 12+
- Redis 6+
Quick Start
- Clone the repository
- Install dependencies:
pip install -r requirements.txt - Configure database settings
- Run migrations:
python manage.py migrate - Start server:
python manage.py runserver
License
[Insert License Information]