507d9a35b1
- Created .gitignore to exclude sensitive files and directories. - Added API documentation in API_DOCUMENTATION.md. - Included deployment instructions in DEPLOYMENT.md. - Established project structure documentation in PROJECT_STRUCTURE.md. - Updated README.md with project status and team information. - Added recommendations and status tracking documents. - Introduced testing guidelines in TESTING.md. - Set up CI workflow in .github/workflows/ci.yml. - Created Dockerfile for backend and frontend setups. - Added various service and utility files for backend functionality. - Implemented frontend components and pages for user interface. - Included mobile app structure and services. - Established scripts for deployment across multiple chains.
43 lines
1.9 KiB
Markdown
43 lines
1.9 KiB
Markdown
# ASLE Documentation
|
|
|
|
This directory contains comprehensive documentation for the ASLE project.
|
|
|
|
## Core Documentation
|
|
|
|
### Business & Strategy
|
|
- [ASLE_Executive_Summary.md](./ASLE_Executive_Summary.md) - Executive overview
|
|
- [ASLE_Whitepaper.md](./ASLE_Whitepaper.md) - Complete whitepaper
|
|
- [ASLE_Pitch_Deck.md](./ASLE_Pitch_Deck.md) - Investor pitch deck
|
|
- [ASLE_Tokenomics_Fee_Model.md](./ASLE_Tokenomics_Fee_Model.md) - Tokenomics and fee structure
|
|
|
|
### Technical Documentation
|
|
- [ARCHITECTURE.md](./ARCHITECTURE.md) - System architecture
|
|
- [PHASES.md](./PHASES.md) - Phase-by-phase implementation breakdown
|
|
- [ASLE_Diagrams.md](./ASLE_Diagrams.md) - System diagrams
|
|
- [ASLE_Smart_Contract_Pseudocode.sol](./ASLE_Smart_Contract_Pseudocode.sol) - Contract pseudocode
|
|
|
|
### Design & Compliance
|
|
- [ASLE_Dashboard_Wireframes.md](./ASLE_Dashboard_Wireframes.md) - UI wireframes
|
|
- [ASLE_Compliance_Mapping.md](./ASLE_Compliance_Mapping.md) - Compliance framework
|
|
|
|
## Project Root Documentation
|
|
|
|
For development and deployment documentation, see the project root:
|
|
|
|
- [../README.md](../README.md) - Project overview and quick start
|
|
- [../STATUS.md](../STATUS.md) - Current project status
|
|
- [../DEPLOYMENT.md](../DEPLOYMENT.md) - Deployment guide
|
|
- [../API_DOCUMENTATION.md](../API_DOCUMENTATION.md) - API reference
|
|
- [../TESTING.md](../TESTING.md) - Testing guide
|
|
- [../RECOMMENDATIONS.md](../RECOMMENDATIONS.md) - Comprehensive recommendations and suggestions
|
|
- [RECOMMENDATIONS_SUMMARY.md](./RECOMMENDATIONS_SUMMARY.md) - Quick summary of key recommendations
|
|
- [RECOMMENDATIONS_REVIEW.md](./RECOMMENDATIONS_REVIEW.md) - Comprehensive review and analysis of recommendations
|
|
- [RECOMMENDATIONS_UPDATES.md](./RECOMMENDATIONS_UPDATES.md) - Summary of updates made to recommendations
|
|
|
|
## Additional Resources
|
|
|
|
- Contract documentation in `../contracts/`
|
|
- API documentation in `../backend/`
|
|
- Frontend documentation in `../frontend/`
|
|
|