Developer Guide - utourismboard/explore-uganda-application-documentation GitHub Wiki
Developer Guide
Table of Contents
Introduction
Welcome to the Explore Uganda App developer documentation. This guide provides comprehensive information for developers working on the project. Whether you're setting up your development environment, understanding the project structure, or preparing for deployment, you'll find detailed instructions here.
Quick Start
# Clone the repository
git clone https://github.com/explore-uganda/mobile-app.git
# Install dependencies
flutter pub get
# Run the app
flutter run
Prerequisites
- Flutter SDK v3.19.0
- Dart v3.3.0
- Android Studio / VS Code
- Git
- Firebase CLI
- Node.js (for backend services)
Development Resources
- Environment Setup Guide
- Project Structure Guide
- Testing Guide
- Deployment Guide
- API Documentation
- System Overview
Contributing Guidelines
Code Style
- Follow the official Dart Style Guide
- Use meaningful variable and function names
- Write comments for complex logic
- Include documentation for public APIs
Git Workflow
graph LR
A[Feature Branch] --> B[Development]
B --> C[Staging]
C --> D[Main]
- Create feature branch from development
- Make changes and commit
- Create pull request
- Code review
- Merge to development
Commit Messages
- Use present tense ("Add feature" not "Added feature")
- Be descriptive but concise
- Reference issue numbers when applicable
Example:
feat: add hotel booking functionality (#123)
fix: resolve crash in payment flow
docs: update API documentation
Pull Request Process
- Update documentation if needed
- Add/update tests
- Ensure CI/CD passes
- Get code review approval
- Squash and merge
Support
- Technical Support: [email protected]
- Developer Chat: [Slack Channel]
- Issue Tracker: GitHub Issues
- Documentation Updates: Submit PR to documentation repository