Gan, Jimmy
6c0d5a4e63
- Flask-based mold cost calculation application - PostgreSQL database with SQLAlchemy ORM - Docker/Podman containerization - Comprehensive documentation in docs/ - Clean, organized codebase without obsolete files - Production-ready deployment configuration - Enhanced pytest configuration with coverage reporting - Master/Development branch structure
63 lines
2.6 KiB
Markdown
63 lines
2.6 KiB
Markdown
# 📚 Mold Cost Calculator - Documentation
|
|
|
|
Welcome to the comprehensive documentation for the Mold Cost Calculator application.
|
|
|
|
## 📖 Documentation Index
|
|
|
|
### 🚀 Getting Started
|
|
- **[README.md](../README.md)** - Project overview, features, and quick start guide
|
|
- **[SETUP.md](SETUP.md)** - Detailed setup instructions for development and production
|
|
- **[PACKAGE_MANIFEST.md](PACKAGE_MANIFEST.md)** - Complete project structure and file inventory
|
|
|
|
### 👥 User Guides
|
|
- **[USER_GUIDE.md](../USER_GUIDE.md)** - End-user instructions for using the calculator
|
|
- **[ADMIN_GUIDE.md](ADMIN_GUIDE.md)** - Administrative operations and management
|
|
|
|
### 👨💻 Developer Resources
|
|
- **[DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md)** - Development workflow, deployment, and technical details
|
|
- **[DEPLOYMENT.md](DEPLOYMENT.md)** - Production deployment procedures
|
|
|
|
### 🔄 Handover & Maintenance
|
|
- **[HANDOVER_CHECKLIST.md](HANDOVER_CHECKLIST.md)** - Complete handover procedures and verification checklist
|
|
|
|
## 🎯 Quick Navigation
|
|
|
|
### For New Users
|
|
1. Start with **[USER_GUIDE.md](../USER_GUIDE.md)** to learn how to use the calculator
|
|
2. Check **[SETUP.md](SETUP.md)** if you need to set up the application
|
|
|
|
### For Administrators
|
|
1. Review **[ADMIN_GUIDE.md](ADMIN_GUIDE.md)** for management tasks
|
|
2. Use **[HANDOVER_CHECKLIST.md](HANDOVER_CHECKLIST.md)** for system handovers
|
|
|
|
### For Developers
|
|
1. Read **[DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md)** for development workflow
|
|
2. Check **[DEPLOYMENT.md](DEPLOYMENT.md)** for production deployment
|
|
3. Review **[PACKAGE_MANIFEST.md](PACKAGE_MANIFEST.md)** for project structure
|
|
|
|
## 📋 Documentation Status
|
|
|
|
| Document | Status | Last Updated | Location |
|
|
|----------|--------|--------------|----------|
|
|
| README.md | ✅ Complete | Current | Root |
|
|
| USER_GUIDE.md | ✅ Complete | Current | Root |
|
|
| ADMIN_GUIDE.md | ✅ Complete | Current | docs/ |
|
|
| DEVELOPER_GUIDE.md | ✅ Complete | Current | docs/ |
|
|
| DEPLOYMENT.md | ✅ Complete | Current | docs/ |
|
|
| SETUP.md | ✅ Complete | Current | docs/ |
|
|
| PACKAGE_MANIFEST.md | ✅ Complete | Current | docs/ |
|
|
| HANDOVER_CHECKLIST.md | ✅ Complete | Current | docs/ |
|
|
|
|
## 🔗 External Resources
|
|
|
|
- **Production Site**: https://moldcost.jimmygan.com/
|
|
- **Development Site**: https://dev.moldcost.jimmygan.com/
|
|
- **Repository**: [Git Repository](https://bitbucket.org/your-repo/mold_cost_online_tool)
|
|
|
|
## 📞 Support
|
|
|
|
For technical support or questions about the documentation, please refer to the contact information in the respective guides or contact the development team.
|
|
|
|
---
|
|
|
|
*This documentation is maintained as part of the Mold Cost Calculator project.* |