docs: Rebuild documentation as enterprise-grade TLAS platform
- Migrate from custom HTTP server to VitePress framework - Rename project to Tokenized License Approval System (TLAS) - Add comprehensive documentation for all stakeholders: - Business: Executive summary, value proposition, governance - Operations: Infrastructure, installation, monitoring, backup - Departments: User guide, workflows, verification, issuance - Developers: API reference, authentication, webhooks, SDKs - Compliance: OWASP, DPDP Act, IT Act, audit framework - Add modern theme with dark mode and full-text search - Update Dockerfile for VitePress build process Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Mahi
71
Documentation/overview/capabilities.md
Normal file
71
Documentation/overview/capabilities.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# Key Capabilities
|
||||
|
||||
## Workflow Engine
|
||||
|
||||
### Visual Workflow Builder
|
||||
- Drag-and-drop stage configuration
|
||||
- Parallel and sequential approval paths
|
||||
- Conditional routing rules
|
||||
- Auto-assignment based on workload
|
||||
|
||||
### SLA Management
|
||||
- Per-stage time limits
|
||||
- Automatic escalation triggers
|
||||
- Manager notifications on breaches
|
||||
- SLA compliance dashboards
|
||||
|
||||
## Document Management
|
||||
|
||||
### Upload and Validation
|
||||
- Multi-format support (PDF, JPG, PNG)
|
||||
- File size and type enforcement
|
||||
- Duplicate detection
|
||||
- Automatic virus scanning
|
||||
|
||||
### Verification
|
||||
- DigiLocker document fetch
|
||||
- Hash-based integrity checking
|
||||
- Officer annotation and comments
|
||||
- Version history tracking
|
||||
|
||||
## Certificate Issuance
|
||||
|
||||
### NFT Minting
|
||||
- Automatic blockchain transaction on approval
|
||||
- Unique token ID per license
|
||||
- Metadata embedding (holder, dates, department)
|
||||
- Document hash for integrity verification
|
||||
|
||||
### Certificate Generation
|
||||
- Department-branded templates
|
||||
- QR code for instant verification
|
||||
- Digital signature embedding
|
||||
- PDF download with watermark
|
||||
|
||||
## Applicant Self-Service
|
||||
|
||||
### Application Portal
|
||||
- License type catalog with requirements
|
||||
- Step-by-step form wizard
|
||||
- Draft saving and resume
|
||||
- Fee calculation and payment
|
||||
|
||||
### Status Tracking
|
||||
- Real-time stage visibility
|
||||
- Timeline view with dates
|
||||
- Notification preferences (SMS/email)
|
||||
- Officer contact for queries
|
||||
|
||||
## Reporting and Analytics
|
||||
|
||||
### Operational Reports
|
||||
- Daily/weekly/monthly volumes
|
||||
- Processing time distribution
|
||||
- Rejection rate analysis
|
||||
- Revenue collection summary
|
||||
|
||||
### Management Dashboards
|
||||
- Department-wise comparison
|
||||
- Officer productivity metrics
|
||||
- Bottleneck identification
|
||||
- Trend analysis
|
||||
104
Documentation/overview/index.md
Normal file
104
Documentation/overview/index.md
Normal file
@@ -0,0 +1,104 @@
|
||||
# Platform Overview
|
||||
|
||||
The Tokenized License Approval System (TLAS) is an enterprise platform that transforms government licensing operations through blockchain-based credential issuance and configurable workflow automation.
|
||||
|
||||
## Context
|
||||
|
||||
Government licensing processes across India handle millions of applications annually. These processes involve multiple stakeholders, complex approval hierarchies, and strict compliance requirements. Traditional systems face persistent challenges that impact both operational efficiency and citizen trust.
|
||||
|
||||
TLAS addresses these challenges through a purpose-built platform that combines workflow automation with cryptographic verification.
|
||||
|
||||
## Platform Objectives
|
||||
|
||||
| Objective | Measurement |
|
||||
|-----------|-------------|
|
||||
| Eliminate document fraud | Zero forged licenses in circulation |
|
||||
| Reduce processing time | 60% reduction in average approval duration |
|
||||
| Ensure complete traceability | 100% audit coverage for all transactions |
|
||||
| Enable citizen self-service | 80% of status inquiries handled without staff |
|
||||
| Support multi-department deployment | Single platform serving 15+ departments |
|
||||
|
||||
## Core Capabilities
|
||||
|
||||
### Tokenized License Certificates
|
||||
|
||||
Every license issued through TLAS is minted as a Non-Fungible Token (NFT) on a private Hyperledger Besu blockchain. This provides:
|
||||
|
||||
- **Cryptographic authenticity**: Certificates are digitally signed and verifiable
|
||||
- **Tamper evidence**: Any modification attempt is detectable
|
||||
- **Instant verification**: QR code scanning validates certificate authenticity
|
||||
- **Permanent record**: Blockchain maintains immutable issuance history
|
||||
|
||||
### Configurable Workflow Engine
|
||||
|
||||
Departments define their approval processes through a visual workflow builder:
|
||||
|
||||
- Sequential and parallel approval stages
|
||||
- Conditional routing based on application attributes
|
||||
- Automated document validation rules
|
||||
- SLA tracking with escalation triggers
|
||||
- Role-based task assignment
|
||||
|
||||
### Unified Operations Dashboard
|
||||
|
||||
Administrators and department heads access real-time visibility into:
|
||||
|
||||
- Application volumes and processing rates
|
||||
- Stage-wise bottleneck identification
|
||||
- SLA compliance metrics
|
||||
- Staff workload distribution
|
||||
- Revenue and fee collection status
|
||||
|
||||
## Deployment Model
|
||||
|
||||
TLAS operates as a multi-tenant platform with department-level isolation:
|
||||
|
||||
```
|
||||
┌─────────────────────────────────┐
|
||||
│ TLAS Platform │
|
||||
├─────────────────────────────────┤
|
||||
┌───────────┼───────────┬───────────┐ │
|
||||
│ │ │ │ │
|
||||
┌────▼────┐ ┌────▼────┐ ┌────▼────┐ ┌────▼────┐ │
|
||||
│ Dept A │ │ Dept B │ │ Dept C │ │ Dept N │ │
|
||||
│ │ │ │ │ │ │ │ │
|
||||
│Workflows│ │Workflows│ │Workflows│ │Workflows│ │
|
||||
│Users │ │Users │ │Users │ │Users │ │
|
||||
│Licenses │ │Licenses │ │Licenses │ │Licenses │ │
|
||||
└─────────┘ └─────────┘ └─────────┘ └─────────┘ │
|
||||
│ │
|
||||
│ Shared Infrastructure │
|
||||
│ - Blockchain Network │
|
||||
│ - Authentication Service │
|
||||
│ - Notification Gateway │
|
||||
│ - Analytics Engine │
|
||||
└─────────────────────────────────┘
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
TLAS integrates with government and third-party services:
|
||||
|
||||
| Integration | Purpose | Protocol |
|
||||
|-------------|---------|----------|
|
||||
| DigiLocker | Citizen identity verification, document retrieval | OAuth 2.0 |
|
||||
| Payment Gateway | License fee collection | REST API |
|
||||
| SMS Gateway | Application status notifications | HTTP |
|
||||
| Email Service | Formal communications and certificates | SMTP |
|
||||
| Legacy Systems | Data migration, reference data sync | Batch/API |
|
||||
|
||||
## User Roles
|
||||
|
||||
| Role | Responsibilities |
|
||||
|------|------------------|
|
||||
| **Applicant** | Submit applications, upload documents, track status, download certificates |
|
||||
| **Department Officer** | Review applications, verify documents, approve/reject/return |
|
||||
| **Department Admin** | Configure workflows, manage staff, view department analytics |
|
||||
| **System Administrator** | Manage departments, monitor platform health, handle escalations |
|
||||
|
||||
## Navigation
|
||||
|
||||
- [Problem Statement](/overview/problem) - Challenges addressed by TLAS
|
||||
- [Solution Architecture](/overview/solution) - Technical design and components
|
||||
- [Key Capabilities](/overview/capabilities) - Feature deep-dive
|
||||
- [Technology Stack](/overview/technology) - Implementation technologies
|
||||
36
Documentation/overview/problem.md
Normal file
36
Documentation/overview/problem.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# Problem Statement
|
||||
|
||||
## Current State Challenges
|
||||
|
||||
### Document Fraud
|
||||
Paper-based licenses are routinely forged. Verification requires manual cross-checking with issuing authorities, which is slow and unreliable. Forged documents circulate undetected for years.
|
||||
|
||||
### Process Opacity
|
||||
Applicants have no visibility into application status. Inquiries require office visits or phone calls. Staff cannot explain delays because tracking is fragmented across manual registers.
|
||||
|
||||
### Inconsistent Processing
|
||||
Same license type processed differently across offices. No standardized workflows. Processing time varies from days to months depending on which officer handles the case.
|
||||
|
||||
### Lost Audit Trail
|
||||
Paper files get misplaced. Handover between officers leaves no record. When disputes arise, reconstructing decision history is impossible.
|
||||
|
||||
### Manual Bottlenecks
|
||||
Every approval requires physical file movement. Officers juggle hundreds of pending files. Urgent applications have no priority mechanism.
|
||||
|
||||
## Quantified Impact
|
||||
|
||||
| Metric | Current State |
|
||||
|--------|---------------|
|
||||
| Average processing time | 45-90 days |
|
||||
| Fraudulent documents in circulation | Estimated 8-12% |
|
||||
| Applicant inquiries requiring staff time | 60% of applications |
|
||||
| Applications with incomplete audit trail | 40%+ |
|
||||
| Staff time on file management vs. review | 50% overhead |
|
||||
|
||||
## Requirements for Solution
|
||||
|
||||
1. **Tamper-proof certificates** that can be verified instantly without contacting the issuing office
|
||||
2. **Real-time status tracking** accessible to applicants through self-service portal
|
||||
3. **Standardized workflows** enforced by the system, not dependent on individual officers
|
||||
4. **Complete audit trail** automatically captured for every action
|
||||
5. **Digital-first processing** eliminating physical file movement
|
||||
100
Documentation/overview/solution.md
Normal file
100
Documentation/overview/solution.md
Normal file
@@ -0,0 +1,100 @@
|
||||
# Solution Architecture
|
||||
|
||||
## System Overview
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────────────────┐
|
||||
│ TLAS Platform │
|
||||
├─────────────────────────────────────────────────────────────────────┤
|
||||
│ ┌──────────────┐ ┌──────────────┐ ┌──────────────┐ │
|
||||
│ │ Applicant │ │ Department │ │ Admin │ │
|
||||
│ │ Portal │ │ Portal │ │ Console │ │
|
||||
│ └──────┬───────┘ └──────┬───────┘ └──────┬───────┘ │
|
||||
│ │ │ │ │
|
||||
│ └─────────────────┼─────────────────┘ │
|
||||
│ │ │
|
||||
│ ┌──────▼───────┐ │
|
||||
│ │ API Gateway │ │
|
||||
│ │ (NestJS) │ │
|
||||
│ └──────┬───────┘ │
|
||||
│ │ │
|
||||
│ ┌─────────────────┼─────────────────┐ │
|
||||
│ │ │ │ │
|
||||
│ ┌──────▼──────┐ ┌──────▼──────┐ ┌──────▼──────┐ │
|
||||
│ │ PostgreSQL │ │ Hyperledger │ │ External │ │
|
||||
│ │ Database │ │ Besu │ │ Services │ │
|
||||
│ └─────────────┘ └─────────────┘ └─────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## Component Responsibilities
|
||||
|
||||
| Component | Function |
|
||||
|-----------|----------|
|
||||
| **Applicant Portal** | Application submission, document upload, status tracking, certificate download |
|
||||
| **Department Portal** | Queue management, application review, approval actions, reporting |
|
||||
| **Admin Console** | Department onboarding, workflow configuration, system monitoring |
|
||||
| **API Gateway** | Authentication, authorization, request routing, rate limiting |
|
||||
| **PostgreSQL** | Application data, user accounts, workflow definitions, audit logs |
|
||||
| **Hyperledger Besu** | NFT minting, certificate verification, immutable transaction record |
|
||||
|
||||
## Data Flow: License Issuance
|
||||
|
||||
```
|
||||
1. Applicant submits application
|
||||
│
|
||||
▼
|
||||
2. System validates documents and routes to workflow
|
||||
│
|
||||
▼
|
||||
3. Officers process through defined approval stages
|
||||
│
|
||||
▼
|
||||
4. Final approval triggers blockchain transaction
|
||||
│
|
||||
▼
|
||||
5. NFT minted with license metadata
|
||||
│
|
||||
▼
|
||||
6. Certificate generated with embedded verification QR
|
||||
│
|
||||
▼
|
||||
7. Applicant notified and certificate available for download
|
||||
```
|
||||
|
||||
## Blockchain Integration
|
||||
|
||||
Hyperledger Besu serves as the certificate authority:
|
||||
|
||||
- **Private network**: Government-controlled nodes, no public exposure
|
||||
- **Permissioned access**: Only authorized services can mint tokens
|
||||
- **Smart contract**: ERC-721 implementation for license NFTs
|
||||
- **Verification API**: Public endpoint for certificate validation
|
||||
|
||||
### NFT Structure
|
||||
|
||||
```json
|
||||
{
|
||||
"tokenId": "0x...",
|
||||
"licenseNumber": "GOA/TRADE/2026/00001",
|
||||
"holder": {
|
||||
"name": "Applicant Name",
|
||||
"identifier": "AADHAAR-XXXX"
|
||||
},
|
||||
"issuingDepartment": "Department of Trade",
|
||||
"issueDate": "2026-02-09",
|
||||
"validUntil": "2027-02-08",
|
||||
"documentHash": "SHA256:abcd1234..."
|
||||
}
|
||||
```
|
||||
|
||||
## Security Architecture
|
||||
|
||||
| Layer | Controls |
|
||||
|-------|----------|
|
||||
| **Network** | HTTPS only, WAF, DDoS protection |
|
||||
| **Authentication** | JWT tokens, session management, DigiLocker OAuth |
|
||||
| **Authorization** | Role-based access control, department isolation |
|
||||
| **Data** | Encryption at rest (AES-256), TLS 1.3 in transit |
|
||||
| **Application** | Input validation, SQL injection prevention, XSS protection |
|
||||
| **Audit** | Immutable logs, tamper detection, compliance reporting |
|
||||
50
Documentation/overview/technology.md
Normal file
50
Documentation/overview/technology.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Technology Stack
|
||||
|
||||
## Frontend
|
||||
|
||||
| Technology | Version | Purpose |
|
||||
|------------|---------|---------|
|
||||
| Angular | 19.x | Application framework |
|
||||
| Angular Material | 19.x | UI component library |
|
||||
| RxJS | 7.x | Reactive state management |
|
||||
| TypeScript | 5.x | Type-safe development |
|
||||
|
||||
## Backend
|
||||
|
||||
| Technology | Version | Purpose |
|
||||
|------------|---------|---------|
|
||||
| NestJS | 10.x | API framework |
|
||||
| TypeScript | 5.x | Type-safe development |
|
||||
| TypeORM | 0.3.x | Database ORM |
|
||||
| Passport | 0.7.x | Authentication |
|
||||
|
||||
## Database
|
||||
|
||||
| Technology | Version | Purpose |
|
||||
|------------|---------|---------|
|
||||
| PostgreSQL | 16.x | Primary data store |
|
||||
| Redis | 7.x | Session cache, rate limiting |
|
||||
|
||||
## Blockchain
|
||||
|
||||
| Technology | Version | Purpose |
|
||||
|------------|---------|---------|
|
||||
| Hyperledger Besu | 24.x | Ethereum-compatible blockchain |
|
||||
| Solidity | 0.8.x | Smart contract language |
|
||||
| Web3.js | 4.x | Blockchain interaction |
|
||||
|
||||
## Infrastructure
|
||||
|
||||
| Technology | Purpose |
|
||||
|------------|---------|
|
||||
| Docker | Container runtime |
|
||||
| Nginx | Reverse proxy, static files |
|
||||
| Let's Encrypt | TLS certificates |
|
||||
|
||||
## Monitoring
|
||||
|
||||
| Technology | Purpose |
|
||||
|------------|---------|
|
||||
| Prometheus | Metrics collection |
|
||||
| Grafana | Visualization |
|
||||
| Loki | Log aggregation |
|
||||
Reference in New Issue
Block a user