emerald-application

byJatin Yadav

create a simple daily-dairy application to mange daily todo and daily working notes

HomeNotesTodosCategories
Home

Comments (0)

No comments yet. Be the first!

System Requirements

System Requirement Document
Page 1 of 4

emerald-application

Introduction

The emerald-application is a personal productivity tool designed specifically for Jatin Yadav. It combines a simple daily diary with to-do management and working notes. The application is tailored to Jatin's needs, focusing on categorized to-do lists and a section for daily notes without unnecessary complexities like reminders.

System Overview

The emerald-application is a web-based application that allows the user to manage daily tasks and notes efficiently. It is designed to be intuitive and straightforward, providing a clean interface for organizing tasks by category and maintaining daily notes. The application is intended for personal use, ensuring that Jatin can manage his daily activities and reflections in one place.

Functional Requirements

  • As Jatin, I should be able to create, edit, and delete to-do tasks.
  • As Jatin, I should be able to categorize my to-do tasks.
  • As Jatin, I should be able to create, edit, and delete daily notes.
  • As Jatin, I should be able to view my to-do tasks and notes in a clean and organized interface.
Page 2 of 4

User Personas

  • Jatin Yadav: The sole user of the application, focusing on personal productivity through managing categorized to-do lists and daily notes.

Visuals Colors and Theme

  • primary: #2E8B57 (Emerald Green)
  • primary_light: #66CDAA (Medium Aquamarine)
  • secondary: #FF6347 (Tomato)
  • accent: #FFD700 (Gold)
  • highlight: #FFA500 (Orange)
  • bg: #F5FFFA (Mint Cream)
  • surface: rgba(46, 139, 87, 0.8)
  • text: #2F4F4F (Dark Slate Gray)
  • text_muted: #708090 (Slate Gray)
  • border: rgba(47, 79, 79, 0.2)

Signature Design Concept

The homepage of the emerald-application will feature an interactive "Emerald Garden" theme. Upon entering the application, Jatin will be greeted with a serene garden scene where each category of to-do tasks is represented by a different plant. Clicking on a plant will "grow" the list of tasks, with smooth animations using framer-motion to expand and collapse the task lists. The daily notes section will be represented by a tranquil pond, where notes appear as floating lily pads. Hovering over a lily pad will reveal the note's content, and clicking will allow for editing. This concept creates a peaceful and engaging environment for managing daily tasks and notes.

Page 3 of 4

Interaction Model & Motion Direction

The landing page will utilize a "parallax" interaction model, providing a layered depth effect as Jatin scrolls through the application. The garden elements will move at different speeds to create a sense of depth and immersion. Internal pages, such as the task and note management sections, will maintain a "static" interaction model to prioritize clarity and ease of use.

Non-Functional Requirements

  • The application must load within 3 seconds on a standard broadband connection.
  • The interface should be responsive and accessible on both desktop and mobile devices.
  • Data integrity must be maintained, ensuring no loss of tasks or notes.

Tech Stack

  • Frontend: React for Web
  • Backend: Python with FastAPI
  • Database: MySQL or MariaDB, using Alembic for migrations
  • Local Orchestration: Docker, docker-compose

Assumptions and Constraints

  • The application is designed for a single user, Jatin Yadav.
  • No reminders or notifications are required.
  • The application will not include user authentication or multi-user support.
Page 4 of 4

Glossary

  • To-do Task: An item on the list of tasks that Jatin needs to complete.
  • Category: A label used to organize to-do tasks.
  • Daily Note: A personal note or reflection entered by Jatin.
  • Emerald Garden: The interactive theme of the application, representing tasks and notes visually.
Home design preview
Home: View Garden
Home: Browse Categories
Todos: View Tasks
Todos: Create Task
Todos: Edit Task
Todos: Delete Task
Todos: Manage Categories
Categories: Create Category
Categories: Edit Category
Notes: View Lily Pads
Notes: Create Note
Notes: Edit Note
Notes: Delete Note