Skip to content

A modern, lightweight app for capturing, organizing, and managing your notes effortlessly.

Notifications You must be signed in to change notification settings

alamin-karno/Notely

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Notely

Notely is a modern and lightweight Android application designed for capturing, organizing, and managing your notes effortlessly. Built using robust Android development practices, it ensures a seamless and efficient user experience.


🌟 Features

  • Create, edit, and delete notes.
  • Organize notes with categories and tags.
  • Lightweight and intuitive user interface.
  • Offline functionality with local storage.
  • Built with modern Android architecture components.

🛠️ Tech Stack & Libraries

  • Kotlin: Primary programming language.
  • MVVM Architecture: For separation of concerns and scalability.
  • Navigation Components: Ensures smooth navigation across the app.
  • ROOM Database: For efficient local data storage.
  • LiveData: To observe data changes in real time.
  • ViewModel: For lifecycle-aware UI logic.
  • Material Design: For a sleek and responsive UI.

🚀 Installation

Prerequisites

  • Android Studio installed (version 2021.1.1 or later recommended).
  • Minimum SDK version: 21 (Android 5.0, Lollipop).
  • Recommended Target SDK: Latest stable version.

Steps

  1. Clone this repository:

    git clone https://github.com/yourusername/notely.git
  2. Open the project in Android Studio.

  3. Sync the project with Gradle files.

  4. Build and run the app on your emulator or physical device.


📂 Project Structure

Notely/
├── app/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/com/alaminkarno/notely/
│   │   │   │   ├── activity/    # Activities classes
│   │   │   │   ├── adapters/    # Adapter classes
│   │   │   │   ├── fragments/   # Fragments classes
│   │   │   │   ├── model/       # Model classes
│   │   │   │   ├── repository/  # Repository classes
│   │   │   │   ├── room/        # Room database classes
│   │   │   │   ├── viewmodel/   # Viewmodel classes
│   │   │   ├── res/             # Layouts, Drawables, Strings, etc.
│   ├── build.gradle             # App-level Gradle file
├── build.gradle                 # Project-level Gradle file
├── README.md                    # Project documentation

✨ Screenshots


👨‍💻 Development

Key Modules

  • Data Layer: Implements the ROOM database for persistent storage.
  • View Layer: XML layouts paired with UI logic.
  • ViewModel Layer: Manages UI-related data in a lifecycle-conscious way.

Future Enhancements

  • Cloud sync for cross-device note management.
  • Rich-text editor for enhanced note-taking.
  • Dark mode support.

🧑‍🤝‍🧑 Contributors

Md. Al-Amin - Creator and Developer


📝 License

This project is licensed under the MIT License. See the LICENSE file for details.


🤝 Support

For questions, feedback, or contributions, feel free to reach out via:


About

A modern, lightweight app for capturing, organizing, and managing your notes effortlessly.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages