The current README provides a good overview of the project but lacks detailed technical guidance for developers and contributors.
Problem:
New contributors may not fully understand:
- How to set up the backend (FastAPI) and IoT components
- Required dependencies and environment setup
- How to run the system locally
- How different layers (IoT, backend APIs, GIS, frontend) interact
Suggested solution:
Enhance the README by including:
- Clear system architecture explanation
- Step-by-step installation and setup guide
- Environment variable configuration
- Instructions for running backend services
- API endpoints overview (CRUD operations)
- Contribution guidelines reference
Importance:
This will improve onboarding for contributors and make the project easier to deploy and extend, especially given its real-world disaster management use case.
The current README provides a good overview of the project but lacks detailed technical guidance for developers and contributors.
Problem:
New contributors may not fully understand:
Suggested solution:
Enhance the README by including:
Importance:
This will improve onboarding for contributors and make the project easier to deploy and extend, especially given its real-world disaster management use case.