feat: Add README files for various modules and routes

This commit is contained in:
Scott Idem
2025-11-17 20:28:34 -05:00
parent 3a0d901a05
commit 5c67421d7e
10 changed files with 353 additions and 0 deletions

View File

@@ -0,0 +1,27 @@
# Aether (AE) Sponsorships Module
The Sponsorships module is designed to manage event or project sponsorships. It includes data structures and functions for handling sponsorship configurations and individual sponsorship records.
## Data Structures
### Sponsorship Configuration (`Sponsorship_Cfg`)
This data structure defines the available sponsorship levels, options, and schedules for a particular event or account. It acts as a template for creating individual sponsorships.
### Sponsorship
This represents an actual sponsorship agreement with an organization or individual. It includes details about the sponsor, the selected level, payment amount, and other relevant information.
## Functionality
This module provides the following functionality:
- **Data Loading:** Functions to load sponsorship configurations and sponsorship records from the backend API.
- **Data Export:** A function to download an export of sponsorship data in CSV or Excel format.
- **Local Caching:** Uses Dexie.js to cache data in the browser's IndexedDB for offline access and faster load times.
- **API Interaction:** All data operations are synced with the backend API.
## Files
- `ae_sponsorships_functions.ts`: Contains functions for loading and processing sponsorship data.
- `db_sponsorships.ts`: Defines the IndexedDB schema for the sponsorships module using Dexie.js.