This Flutter mobile app is designed to provide a secure and convenient way for users to manage their documents digitally. It includes features for user authentication, role selection, KYC (Know Your Customer) verification, document management, course application, and seeker onboarding.The app is currently in active development for the Android platform.
- [Features]
- [Branching Strategy]
- [Installation]
- [Contributing]
- [License]
- [Contact]
- User Authentication:
- Description: Users can authenticate using their phone number and verify their identity using OTP (One-Time Password).
- Role Selection:
- Description: Users can select their role as an agent or seeker based on their requirements and preferences.
- KYC Verification:
- Description: The app facilitates KYC verification for users to ensure compliance with regulatory requirements.
- MPIN Creation and Verification
- Description: Users can create and verify an MPIN to add an extra layer of security before sharing documents.
- Functionality:
- MPIN creation: Users must first create a unique MPIN before document sharing.
- MPIN verification: Before sharing sensitive documents, users are prompted to enter their MPIN to authenticate their identity.
- Security enhancement: MPIN serves as an additional security measure, protecting documents from unauthorized access or sharing.
- Document Management
- Description: Users can manage their documents digitally within the app.
- Functionality:
- Digital wallet: Users have access to a digital wallet where they can store their documents securely.
- Document actions:
- View: Users can view the details of their stored documents.
- Update: Documents can be updated with new information or versions.
- Share: Users can share their documents with authorized parties.
- Delete: Unwanted or outdated documents can be deleted from the digital wallet.
- Consent Information Management with Expiry
- Description: Users can manage consent information associated with their documents, including a duration for consent expiration.
- Functionality:
- Specify duration: When granting consent for document access or sharing, users can specify a duration for which the consent remains valid.
- Automatic expiration: After the specified duration elapses, the consent for document access expires automatically, restricting further access unless renewed.
- Course Application and Purchase
- Description: Users can apply for courses and make payments based on their preferences and choices.
- Functionality:
- Course Selection: Users can browse and select courses that match their interests and educational needs.
- Application Process: Users can apply for selected courses directly through the app.
- Payment Integration: Users can complete their course enrollment by making secure payments using integrated payment gateways.
- Confirmation: Upon successful payment, users receive a confirmation for their course enrollment.
- Course Status and Details
- Description: Users can check the status of their enrolled courses and view detailed information about each course.
- Functionality:
- Status Tracking: Users can track the progress and status of their enrolled courses, including progress and completion status.
- Detailed Course Information: Users can access comprehensive details about each course, including syllabus.
- Agent Onboarding and Management
- Description: Agents can onboard seekers and manage their applications and courses on their behalf.
- Functionality:
- Seeker Onboarding: Agents can assist seekers by onboarding them into the app and setting up their profiles.
- Application Management: Agents can apply for courses on behalf of seekers, ensuring all necessary information is accurately provided.
- Payment Processing: Agents can manage the payment process for seekers, ensuring secure and successful transactions.
- Course Tracking: Agents can monitor the course status and progress for seekers, providing updates and support as needed.
- Document and Consent Management: Agents can also manage documents, KYC verification, and consent information for seekers, following the same security and privacy protocols as individual users.
- Feature Branches
- For new features:
- Format: feature/brief-description
- Example: feature/user-authentication, feature/shopping-cart
- Bugfix Branches
- For fixing bugs:
- Format: bugfix/brief-description
- Example: bugfix/login-error, bugfix/cart-not-updating
- Hotfix Branches
- For urgent fixes that need to be deployed immediately:
- Format: hotfix/brief-description
- Example: hotfix/critical-security-patch, hotfix/payment-gateway
- Improvement Branches
- For improvements or refactoring that aren't new features:
- Format: improvement/brief-description
- Example: improvement/code-refactor, improvement/ui-enhancements
- Release Branches
- For preparing a release:
- Format: release/version-number
- Example: release/1.0.0, release/2.1.3
- Experiment Branches
- For experimental features or spikes:
- Format: experiment/brief-description
- Example: experiment/new-ui-concept, experiment/performance-tuning
- Chore Branches
- For routine tasks such as updating dependencies or documentation:
- Format: chore/brief-description
- Example: chore/update-dependencies, chore/add-documentation
To install and run the app locally, follow these steps:
-
Ensure you have Flutter installed on your machine. If not, follow the installation instructions on the Flutter website.
-
Clone the repository:
git clone https://gitlab.thewitslab.com/wil-workspace/xplor/xplor-reference-app
-
Navigate to the project directory:
cd [path to project-directory]
-
Install dependencies:
flutter pub get
-
Run the app:
flutter run
Contributions are welcome! Please follow these steps:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE for more information.
Your Name - your@email.com
Project Link: [https://gitlab.thewitslab.com/wil-workspace/xplor/xplor-reference-app]