ci(app): #1 documentation readme and contribution

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+
+# Contributing to Manzon
+
+Thank you for considering contributing to the Manzon application! To maintain a collaborative and efficient workflow, please follow these guidelines:
+
+## Code of Conduct
+Please read our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing.
+
+## How to Contribute
+1. **Fork the repository** to your own GitHub account.
+2. **Clone** the repository to your local machine:
+   ```bash
+   git clone https://github.com/your-username/Manzon.git
+   ```
+3. **Create a new branch** for your feature or bugfix:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+4. **Make your changes** and ensure your code follows the project's coding standards.
+5. **Commit your changes** with a descriptive commit message (see below for guidelines).
+6. **Push to your branch**:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+7. **Create a pull request** on the main repository and provide a detailed description of your changes.
+
+## Commit Guidelines
+Writing good commit messages is crucial for maintaining a readable project history. Follow these guidelines to make your commits clear and useful:
+
+1. **Use the present tense** ("Add feature" not "Added feature").
+2. **Use the imperative mood** ("Move file to..." not "Moves file to...").
+3. **Keep the subject line (first line) under 50 characters**.
+4. **Separate subject from body with a blank line**.
+5. **Include a detailed description in the body**, if necessary. Explain the what, why, and how of the change.
+6. **Reference relevant issues** using keywords (e.g., "Closes #123" or "Fixes #456").
+
+### Example Commit Message
+```
+feat: Add user authentication
+
+- Implement login and registration functionality
+- Integrate with Firebase for backend support
+- Add validation for user inputs
+- Closes #101
+```
+
+## Reporting Issues
+If you find any bugs or have suggestions for improvements, please open an issue on GitHub and provide as much detail as possible.
+
+## Pull Request Process
+1. Ensure there are no conflicts with the base branch.
+2. Provide a clear and detailed description of your changes.
+3. Reference any relevant issues or feature requests.
+
+Thank you for contributing!

README.md

@@ -1,2 +1,88 @@
-# manzon
+
+# Manzon Application
+
 Manzon is a digital solution aimed at formalizing and enhancing Association meetings, which are traditional savings and loan associations commonly practiced in various communities. The application streamlines contributions, manages savings, offers loans, and supports various financial objectives of Association groups.
+
+## Table of Contents
+- [Introduction](#introduction)
+- [Objectives](#objectives)
+- [Features](#features)
+- [Technology Stack](#technology-stack)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contact](#contact)
+
+## Introduction
+Manzon is designed to digitize and enhance traditional Association practices, providing tools for better financial management, transparency, and financial inclusion. This application facilitates contributions, manages loans and savings, and supports community financial goals.
+
+## Objectives
+- **Digitize Association Practices**: Create an application to manage contributions, loans, and savings.
+- **Enhance Financial Management**: Provide tools for better financial planning and transparency.
+- **Promote Financial Inclusion**: Make financial services accessible to a broader population.
+- **Support Community Goals**: Facilitate contributions for events, school fees, household assets, and other community objectives.
+
+## Features
+- **Organization Management**: Create and manage Association groups, invite members, and set rules for contributions and loans.
+- **Contribution Management**: Integrate mobile money for contributions, track contributions and disbursements, and provide automated notifications.
+- **Loan System**: Offer loans to members, set interest rates and repayment options, and track loan repayments.
+- **Reporting and Analytics**: Provide real-time statistics, generate financial reports, and share them.
+- **Notifications**: Send automated reminders and confirmations via WhatsApp.
+- **Meeting and Savings Management**: Manage mutual savings with yearly objectives and handle multiple Association groups.
+
+## Technology Stack
+- **Frontend**: Flutter or FlutterFlow for cross-platform mobile development.
+- **Backend**: Firebase for backend services including authentication, database, and cloud functions.
+- **Design**: Figma for UI/UX design and prototyping.
+
+## Installation
+To get started with Manzon, follow these steps:
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/CamaireTech/Manzon.git
+   ```
+2. Navigate to the project directory:
+   ```bash
+   cd Manzon
+   ```
+3. Install dependencies:
+   ```bash
+   flutter pub get
+   ```
+
+## Usage
+Run the application on your local development environment:
+```bash
+flutter run
+```
+
+## Contributing
+We welcome contributions to enhance the Manzon application. Please follow these steps to contribute:
+
+1. Fork the repository.
+2. Create a new branch:
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+3. Make your changes and commit them:
+   ```bash
+   git commit -m "Add feature description"
+   ```
+4. Push to the branch:
+   ```bash
+   git push origin feature/your-feature-name
+   ```
+5. Open a pull request.
+
+## License
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+For any inquiries or support, please contact us at:
+- Email: [email protected]
+- Address: Cameroon-Yaounde, Ngoa Ekelle
+- Phone: +237 690160047
+
+