Skip to content

Latest commit

 

History

History
87 lines (61 loc) · 4.01 KB

README.md

File metadata and controls

87 lines (61 loc) · 4.01 KB
Raw

Qurio Notes - A minimalistic notepad

About

This project was created to explore my own UI/UX design capabilities. It offers clean and efficient functionality, and is designed to distract the user as little as possible.

🌇 Day Mode

Home Create a note Edit a note About Share or save a note

🌆 Dark mode

Home Create a note Edit a note About Share or save a note

🏗️ Built With

  • Kotlin - First class and official programming language for Android development.
  • Koin - A smart Kotlin dependency injection librar
  • Coroutines - For asynchronous work and more..
  • Android Architecture Components - A collection of libraries that help you design robust, testable, and maintainable apps.
    • Flow - A flow is an asynchronous version of a Sequence, a type of collection whose values are lazily produced.
    • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
    • Room - SQLite object mapping library.
    • Jetpack Navigation - Navigation refers to the interactions that allow users to navigate across, into, and back out from the different pieces of content within your app
  • Material Components for Android - Modular and customizable Material Design UI components for Android.
  • Figma - Figma is a vector graphics editor and prototyping tool which is primarily web-based.

🏯 Package Structure

com.aredruss.qurio # Root Package
├── di                  # Koin DI Modules 
├── domain              # Local Data Storage
│   ├── database        # Database Instance and the Data Access Object for Room
├── model               # Model classes [Notes]
├── repo                # Used to handle all data operations
├── view                # Activity/Fragment View layer
│   ├── about           # App's summary
│   ├── home            # App's Home
│   ├── notes           # Create and Edit notes
│   ├── utils           # Base classes and extensions
├── helpers             # All extension functions and utilities

🏠 Architecture

This app uses MVVM architecture.

👏 Credits

  • Special Thanks to gmk57 for all the cool gists

📖 License

    Apache 2.0 License


    Copyright 2021 Alexander Medyanik

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.