You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
When contributing to this repository, please follow these guidelines to ensure a smooth and efficient collaboration process.
4
+
5
+
## Conventional Commits
6
+
7
+
Use the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for commit messages. This helps maintain a clear and consistent commit history.
8
+
9
+
- Commit message must be in **English**.
10
+
- Use present tense and an imperative mode.
11
+
- Include a scope to specify the area of the codebase that is affected by the commit (optional but recommended).
12
+
- You can use the following types of commits:
13
+
-`feat`: A new feature.
14
+
-`fix`: A bug fix.
15
+
-`docs`: Documentation changes.
16
+
-`refactor`: Code refactoring without changing functionality.
17
+
-`test`: Adding or updating tests.
18
+
-`chore`: Changes to the build process or auxiliary tools and libraries.
19
+
20
+
## Example Commit Message
21
+
22
+
```
23
+
feat(home): add home screen.
24
+
```
25
+
26
+
```
27
+
docs: update read me file with installation instructions.
This repository contains the mobile application for the Intiva Platform, which is a platform for managing expenses, savings and incomes.
4
+
The mobile application is built using Kotlin and Jetpack Compose and provides a user-friendly interface for users to interact with the features.
5
+
It also uses Room for local data storage and Retrofit for network communication with the backend API.
6
+
7
+
## Summary
8
+
9
+
This application is a mobile application for the Intiva Platform. It includes the following features:
10
+
11
+
- Transaction management: Register and monitor all transactions, including expenses and incomes.
12
+
- Categorization: Classify transactions into different categories for better organization and analysis.
13
+
- Budget management: Set and track budgets for different categories of expenses and for different periods of time.
14
+
- Savings management: Set and track savings goals, and monitor progress towards those goals.
15
+
- Reminders and notifications: Set up reminders for upcoming bills, budget limits, and savings goals, and receive notifications to stay on track.
16
+
- Family group management: Create and manage family groups to share expenses, budgets, and savings goals among family members.
17
+
- Reporting and analytics: Generate reports and visualizations to analyze spending patterns, savings progress, and overall financial health.
18
+
- User management: Manage user accounts, including registration, authentication, and authorization.
19
+
20
+
## Technologies Used
21
+
22
+
For the development of this API, the following technologies were used:
23
+
24
+
### Main Stack
25
+
26
+
- Kotlin: The programming language used for the development of the mobile application.
27
+
- Jetpack Compose: A modern toolkit for building native Android UI, used to create the user interface of the mobile application.
28
+
- Room: A persistence library for Android, used for local data storage in the mobile application.
29
+
- Retrofit: A type-safe HTTP client for Android, used for network communication with the backend API.
30
+
- Coroutines: A concurrency framework for Kotlin, used for asynchronous programming in the mobile application.
31
+
- Dagger Hilt: A dependency injection framework for Android, used for managing dependencies in the mobile application.
32
+
- Navigation Component: A framework for handling navigation in Android applications, used for managing navigation between different screens in the mobile application.
33
+
- ViewModel: A component of the Android Architecture Components, used for managing UI-related data in a lifecycle-conscious way in the mobile application.
34
+
35
+
### Approaches and Patterns
36
+
37
+
- MVVC (Model-View-ViewModel): The application follows the MVVC architectural pattern, which separates the user interface (View) from the business logic (ViewModel) and the data (Model).
38
+
- Clean Architecture: The application is structured following the principles of Clean Architecture, which promotes separation of concerns and makes the codebase more maintainable and testable.
39
+
- Feature-based module organization: The codebase is organized into modules based on features, which helps to keep the codebase organized and makes it easier to navigate and maintain.
40
+
41
+
## Documentation
42
+
43
+
The project includes basic documentation and is available in the `docs` folder. It includes:
44
+
45
+
- C4 Model Software Architecture Diagrams: includes context, container and component level diagrams to provide an overview of the system architecture and its components.
46
+
- Class Diagrams: includes class diagrams to illustrate the structure of the codebase and the relationships between classes.
0 commit comments