GruvNote Notes App

Project Proposal: Gruvnote Notes App

Prepared by:

Osman Adam
Email: contact.namso@gmail.com
Start Date: 29/09/2024

For the PDF Document Link: Click here

Introduction

GruvNote features include the following:

• Creating Notes: Users are capable of performing CRUD operations on notes.
• Offline Access: GruvNote doesn’t require an internet connection to access notes.
• Accessing Notes by Date: Users can select a specific date to display the notes created on that date.

Purpose

The primary purpose of GruvNote is to provide users with a reliable way to read and write notes.

Target Audience

• Writers: Individuals who need a fast way to write their thoughts.
• Students: For all ages, GruvNote can be used to store everyone’s notes in a safe place.

Technical Overview

Development Environment

• Primary IDE: Android Studio
• Language: Kotlin
• Layout Language: XML

Architecture

• Design Structure: Model-View-ViewModel (MVVM)
• Components: Packages, Activities, and XML Layouts

Data Management

• SQLite Database: To store all notes’ names, content, and dates.
• Repository Patterns

Security

• Encryption Utilities: For protecting sensitive user data.
• Android Keystore System: For secure key storage.

Performance Optimizations

• RecyclerView: With efficient view holders for smooth scrolling and navigation.

Expected Outcomes

User Adoption if Released:

• Reach: At least 20 active users by the end of the year.
• Engagement: Attain an average daily-to-monthly active users’ ratio of 10%.

User Satisfaction:

• Rating: Achieve at least a rating of 3.0+ stars on Google Play Store.

Accessibility:

• Compliance: Meet the WCAG 2.1 AA standards for accessibility.
• Language Support: Provide support for at least two languages by the end of the second year.

Libraro Requirement Specification

Download the Requirement Specification PDF File:

Download

Shape

1. Introduction

Purpose of Document

This document outlines the detailed requirements for the GruvNote. It serves as a reference for developers throughout the development process.

Overview of the App

GruvNote is an Android Notes App designed to provide users with an appealing notes reading/writing experience. It allows users to:

• Write Notes
• Enjoy an easy-to-use interface with offline support for written notes

Shape

2. Functional Requirements

User Actions

• Perform CRUD operations on written notes.
• Access Notes from a specified date.

System Behaviours

• Save written notes to the local SQLite database.
• Load written notes on RecyclerView during load time.
• Provide offline access to all notes.

Shape

3. Non-Functional Requirements

Performance

• App launch time should be under 3 seconds on average devices.
• Calendar date clicks should display notes from that date within less than 1 second.
• Scrolling through notes should be smooth, even on minimum device specifications.
• The maximum app size at installation should not exceed 12MB.

Usability

• Use of clear and readable typography.
• Support for multiple themes.
• A Material Design 3 compliant user interface.

Reliability

• Ensure a crash-free rate of at least 97%.

4. Technical Requirements

Development Tools

• Android Studio Koala as the development environment.
• Kotlin 1.5 or higher as the programming language.
• Minimum SDK: API 24 (Android 7.0).
• Preferred SDK: API 33 (Android 13).
• Use GitHub for version control.

Frameworks and Libraries

• AndroidX libraries for modern Android development.
• SQLite for database storage.
• RecyclerView for displaying notes.

Testing Requirements

• Unit tests for the app’s core logic.
• Performance testing using Android Profiler.

Shape

5. Constraints

Platform Limitations

• The app is Android-only.
• Supports Android 7.0 (API 24) and above.
• Maximum characters on a note shouldn’t exceed 12,000 chars.
• Maximum number of notes is limited by the device’s available space.

Development Constraints

• The app must comply with the Google Play Store policies.
• Third-party libraries used in development must be widely adopted and well-maintained.

1. 2024-11-22 10-28-512024-11-22 10-28-51 Title Page

• GruvNote Notes App. 

• Osman Adam 

• 13/07/2024 

2. Introduction

• Purpose of this wireframe is to visually map out app screens and UI interactions between different components on the GruvNote App