feat: Add README files for various modules and routes
This commit is contained in:
27
src/lib/ae_sponsorships/README.md
Normal file
27
src/lib/ae_sponsorships/README.md
Normal 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.
|
||||
Reference in New Issue
Block a user