Skip to content

Latest commit

 

History

History
80 lines (60 loc) · 4.94 KB

README.md

File metadata and controls

80 lines (60 loc) · 4.94 KB
Raw

Note App

Description

The project can keep your notes. You can edit your notes and delete them. You need to log in with e-mail and password. You can also use Google authentication to log in.

To see the sqlite version of the project you can go branches -> sqlite_version

Pages in the app
Login Screen
Notes Screen
Add Edit Note Screen

Prerequisites

  1. Clone the repo
https://github.com/enesokurterzi/note-app.git
  1. Enter your web client id in local.properties
WEB_CLIENT_ID='ENTER YOUR API'

Module structure

Tech Stack

  • Multi-Module Setup: Utilizing a sophisticated structural design, the project logically segregates its elements to facilitate maintenance and enhance scalability.

  • Clean Architecture Approach: Following clean architecture principles, the project ensures modularity, independence, and testability of code components.

  • MVI Design Pattern: Employing the Model-View-Intent (MVI) design pattern, the project establishes a distinct division between user interface actions, state management, and business logic, resulting in improved code clarity and ease of maintenance.

  • Dependency Injection With Hilt: Leveraging Hilt for dependency injection, the project reduces dependencies between components and enhances testability.

  • Coroutines & Flows: Handles asynchronous tasks smoothly and efficiently, enhancing UI responsiveness with simplified code for complex tasks.

  • Firebase: Firebase is a platform by Google offering developers a range of tools for app development, including user authentication, database management, file storage, analytics, messaging, and more, speeding up development and scaling processes.

  • Android Credentials: Provides tools for storing and managing user credentials (such as passwords and usernames) securely in Android applications, offering APIs to securely store and share credentials across apps, enhancing user experience and application security.

  • Google Identity: Offers functionality for managing Google Identity, enabling seamless authentication and access to user information across Android applications.

  • Secrets Gradle Plugin: Facilitates secure management of API keys and other sensitive information within Android projects.

  • KSP: Provides the Kotlin Symbol Processing (KSP) framework, enabling advanced compile-time code generation and analysis for Kotlin projects, enhancing developer productivity and performance.

  • Material 3: Google's latest design language for Android, enhancing visual appeal and user experience.

  • Splash Screen: The Splash Screen library for Android apps is designed to provide users with a welcoming screen upon app launch.

  • Localization: Ensures that an app can adapt its content and user interface to different languages and regions, enabling it to reach a diverse global audience.

  • Dark / Light Theme: Dark and Light themes in Android allow users to customize their app's appearance based on their preferences and environmental conditions, providing flexibility and enhancing usability in various lighting environments.

    Images from the Project

Light Theme

Login Screen Login Screen Notes Screen Add Edit Note Screen
light_theme_login_screen_login light_theme_login_screen_sign_up light_theme_notes_screen light_theme_add_edit_note_screen

Dark Theme

Login Screen Login Screen Notes Screen Add Edit Note Screen
dark_theme_login_screen_login dark_theme_login_screen_sign_up dark_theme_notes_screen dark_theme_add_edit_note_screen

Video from the Project

project_video.mp4