Giter Club home page Giter Club logo

takenotesappdev's Introduction

TakeNotesAppDev

Table of Contents

  1. Overview
  2. Project Requirements Table
  3. Solution Architect Diagram
  4. WireFrames
  5. User Stories and Use Cases
  6. Database Design
  7. Data Access Layer

Overview

Purpose

The purpose of the TakeNotes application will be to keep simple notes, images, and ideas in the form of a post-it note board. I would eventually like to consider the option of cloud support, allowing this application to be cross platform, however, for the moment I will be focusing on single platform. This application should allow the user to organize and archive their notes as needed.

Function

Much like Google Keep, I would like to create a board (home page) that allows the user to click on an icon and create a new note. This home page would display all notes relevant to the user. Notes could have color background options for grouping, and new notes can be text or image. Notes could also be organized by label, files, or archive. Google Keep currently only organizes by label - which will display groups of notes flagged with the same label; and archive โ€“ a file notes can be sent when the user wants to remove them from the main board. There is however, no current option for creating files from the main board or within the archive, which I would like to add in this application. Users will have the ability to add or delete notes as needed. Additional features that I would also like to include would be bullet list creation, alerts, and the ability to send notes via email.

Back to Top

Project Requirements Table

ID Number Requirement
001 The software shall allow the user to create a new account using an email address and password of their choice so long as it meets criteria
002 The software shall allow the user to access their created account using the email and password chosen at the time of creation
003 The software shall, upon log in, display all of the users previous, non-archived notes and reminders
004 The software shall allow the user to create a new note when clicking on the appropriate icon
005 The software shall allow the user to alter their dashboard display view when clicking on the appropriate icon. Users shall be allowed to toggle between note and list view
006 The software shall allow the user to create new folders for sorting and storing notes away from the main dashboard by clicking on the appropriate icon
007 The software shall allow users to move notes from folders to dashboard to archive freely by clicking on the appropriate icon
008 The software shall allow users to delete a note by clicking on the appropriate icon, giving a warning message before deletion

Back to Top

Solution Architect Diagram

As this is a very simple application, the actors would mainly consist of: the user, the database, and potentially the site administrator. Solution Architect Diagram

Back to Top

WireFrames

Creating a New Account - DRAFT

Users would view this screen when creating a new account. Creating a New Account

Log Into Account - DRAFT

Users would view this screen when logging in to thier existing account. Log Into Account

Home Dashboard - Sticky Notes View - DRAFT

Users would view this screen as their landing/home page upon log in. Home Dashboard Sticky View

Home Dashboard - List View - DRAFT

This is a second option for viewing the landing/home page. Home Dashboard List View

Create/Edit Note View - DRAFT

Users would view this screen when creating or editing a note. Create Edit Note

Back to Top

User Stories and Use Cases

User Stories and Use Cases include the following actions: Creating an account, Logging into an exisiting account, Creating a new note, Editing an existing note, Creating a file, Moving a note to the Archive, and Deleting a note.

User Stories

User Stories can be found here

Back to Top

Use Cases

Use Cases can be found here

Back to Top

Use Case Diagram

Use Cases Diagram

Back to Top

Database Design

Chen Model Entity Relationship Diagram

ChenERD

Back to Top

UML Class Diagram

UML Class Diagram

Back to Top

Data Access Layer

Note Class Code

Note Class Code Note Class Code2

Note Controller Code

Note Controller Code

HTTP Response

http Response

takenotesappdev's People

Contributors

emharris589 avatar

Watchers

 avatar

takenotesappdev's Issues

Notes save to Archive

As a user I want to archive old notes

  • Notes can be moved from dashboard to archive
  • Notes can be moved from folders to archive
  • Notes show in archive and not elsewhere

Note users can use collaboration option

As a user, I want to give access to a board to a contact

  • User can send invite to those in contact list
  • If invite is outside of contact list, option to use email address is offered
  • If user chooses email invite, pop-up menu to add email details activates
  • invite is sent to user contact
  • contact is able to open, edit, and delete only notes on that board

Notes can be attached to calendar

As a user, alerts and reminders I create can be added to my phone calendar app

  • Option shows to add to calendar when creating alert or reminder
  • Interface with calendar app works as desired
  • alert or reminder show on calendar like those created through calendar
  • deleting from calendar does NOT delete note, just alert/reminder

Notes Auto Date

Notes are auto date and timed upon creation and this is displayed on the note

  • Note creation prompts auto date and time
  • auto date and time displays in appropriate location on note
  • auto date and time does not change when note is opened or updated

Confirm message before note is deleted

System displays pop-up message to confirm user wants to permanently delete note before it is deleted.

  • User clicks delete and pop-up message is displayed
  • Buttons work as expected
  • If yes, note deletes and is no longer stored
  • If no, window closes with no change to note

UI is fully functional

As a user, I am able to use all functions of the UI and they work as expected

  • All links work as expected
  • All Note functions work as expected
  • All Menu items work as expected
  • User Log in works as expected
  • Trash works as expected

Notes Dashboard Display

As a user I want to see my notes Dashboard where all of my active notes are displayed

  • HTML Code created and displays notes properly
  • All active notes are displayed
  • All notes have an indicator if they are stored elsewhere

User Account data stored/retrieved

As a user I want to create an account and log in

  • User is able to create an account
  • New account data is stored and user can log in
  • Log in page works as expected
  • Log in pages displays message if no account if found
  • User data is stored and retrieved appropriately for login
  • When user logs in notes are displayed, no missing data
  • New notes are saved to user account

Note lock for boards using collaboration

As a user, I want to share a board, but don't want collaboration partners to be able to delete notes

  • User offers collaboration link
  • Locks can be update per collaboration invite
  • Read only works as expected
  • Read/edit only works as expected
  • Read/edit/delete works as expected

Users can assign alerts/reminders for notes

User can create alerts and reminders for notes

  • Alert icon responds appropriately when clicked
  • Alert icon allows user to select alert sound and date/time for alert
  • Alert is saved and sounds when indicated
  • Reminder icon responds appropriately when clicked
  • Reminder icon allows user to select reminder sound and date/time for reminder
  • Reminder is saved and sounds when indicated

Notes displayed with folder or label

As a user, if I have moved my notes to a folder, only notes sent to that folder display.

  • Notes storage location updated when folder is selected
  • Notes sent to folder display on dashboard but have icon showing folder storage
  • In Folder only notes indicated for that folder show
  • Data transfers appropriately

Notes Data Transfers properly

As a user I want my notes data to transfer properly no matter which folder they are in.

  • Notes data displays appropriately on dashboard
  • Data is stored when note is saved and retrievable
  • Storage location is updated when folder is created and selected
  • Note data displays appropriately when selected folder is opened
  • Note can be moved from folder to folder, or dashboard, with no interruption of data storage or display

Notes can be colored

As a user I want to change the background color of the note to help with organization

  • Color change option shows in note
  • Color change option shows a number of colors to choose from
  • Color change option allows user to select color
  • Color change option updates color on color selection
  • Color option updates each time new color is chosen

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.