HKFR - Hong Kong Financial Reporting Platform¶
Welcome to the HKFR (Hong Kong Financial Reporting) platform documentation. HKFR is a smart, collaborative software platform designed to modernize and streamline the creation of financial and regulatory reports for Hong Kong listed companies.
What is HKFR?¶
HKFR is a centralized, efficient, and intelligent solution for reporting professionals (including finance, legal, ESG, and investor relations teams) and their collaborators (such as external auditors, legal reviewers, and designers) to produce complex documents like annual reports, IPO documents, and ESG reports with greater ease, accuracy, and speed.
The Problem We Solve¶
Traditional report creation processes are often:
- Inefficient: Manual workflows with disconnected tools
- Error-prone: Multiple file versions and manual data consistency checks
- Time-consuming: Complex coordination between multiple stakeholders
- Costly: High administrative burden and increased risk of errors
Our Solution¶
HKFR transforms this fragmented and labor-intensive process into a seamless and intelligent workflow by:
- ✅ Automating tedious tasks and data consistency checks
- ✅ Facilitating real-time collaboration between team members
- ✅ Ensuring data integrity across all report sections
- ✅ Simplifying regulatory compliance and formatting requirements
- ✅ Integrating AI-powered content generation and assistance
Key Features¶
🚀 Report Creation & Management¶
- Create reports from scratch with customizable templates
- Define report structure with sections and sub-sections
- Set basic report information (type, company, fiscal year, stock code)
👥 Collaborative Editing¶
- Real-time co-editing with rich text formatting
- In-document commenting and teammate tagging
- Role-based access control and permissions
📊 Financial Data Integration¶
- Upload and integrate Excel spreadsheets
- Map financial data to report text
- Create annotations and footnotes for data points
🎨 Asset Management¶
- Central photo/graphic library
- Image insertion and basic editing capabilities
- Brand consistency maintenance
🔍 Review & Approval¶
- Dedicated review mode for stakeholders
- Formal approval workflows
- Version history and change tracking
📤 Export Capabilities¶
- Export to PDF and DOCX formats
- Professional formatting for regulatory compliance
- Batch export and download options
Technology Stack¶
- Frontend: Next.js 15 with React 19
- Backend: Next.js API routes with JWT authentication
- Database: MongoDB for documents, PostgreSQL for relational data
- Cloud: Google Cloud Platform (GKE, Cloud Storage, Cloud SQL)
- Infrastructure: Terraform + ArgoCD for GitOps deployment
Quick Links¶
- 🌐 Live Application: https://hkfr.live
- 📚 User Guide: Getting Started
- 🛠️ Developer Guide: Local Development
- ☁️ Infrastructure: Cloud Setup
Support¶
For technical support or questions, please:
- Check this documentation first
- Contact the development team via GitHub issues
- Reach out to Zhen Yuan (@zhenyuan1001) for infrastructure access
HKFR is developed as part of CSC301 at the University of Toronto, created to modernize financial reporting for Hong Kong enterprises.