Giter Site home page Giter Site logo

jiseeeh / u-do-note Goto Github PK

View Code? Open in Web Editor NEW
2.0 2.0 0.0 2.73 MB

License: MIT License

Kotlin 0.02% Swift 0.59% Objective-C 0.01% Dart 90.00% CMake 3.78% C++ 4.76% C 0.28% HTML 0.36% Shell 0.20%
flutter flutter-firebase google-ml-kit note-taking notes-app openai-api

u-do-note's Introduction

U Do Note

A note-taking app that incorporates AI to suggest the best learning method for each note and provides users with progress reports to help them see what they need to improve.

u-do-note's People

Contributors

jiseeeh avatar santosmarc14 avatar semantic-release-bot avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

u-do-note's Issues

Sign Up and Login feature

As a

user

I want to

be able to sign up and log in to the app

To

use the app


Acceptance Criteria

  • transition from intro page to sign up / log in
  • transition to log in on sign up
  • link to sign up if the current page is login and vice versa
  • transition to the homepage after logging in
  • working sign up
  • working login
  • complete UI

Onboarding UI

As a

user

I want to

to be onboarded with what the heck is this app, what does this do

To

be hooked asfp


Acceptance Criteria

  • replaced temporary onboarding UI in the app

Improved analytics screen

  • Bring back descriptive analysis
  • Brief summary/interpretation of graphs
  • Graphs/Charts per technique/topic

Complete ui design for every subject

As a

dev

I want to

see a section where the user can add a subject and add notes to it.

To

easily view their notes for every subject


Acceptance Criteria

  • finished ui section
  • finished note taking section

Add Spaced Repetition

Warning

Most are tentative

  • app can give summary of the note
  • quiz
  • one time summary or reviewer on first open
  • next quiz will be per 2hrs, without showing again the summary/reviewer
  • save time on db
  • firebase shape will have array of scores e.g [6,3,7]
  • also allow create new one or use existing to take a quiz

Add quiz screen for techniques that it applies

As a

user

I want to

have take an assessment for the learning technique I'm using

To

see if I my review went well


Acceptance Criteria

  • must have a timer for every question, maybe 30 seconds. ( or just a long list of questions idk )
    [ ] shows the correct answer after every question (if used a timer not a long list of questions)
  • allow them to review the questions after the session (before continuing)
  • save the session for future retake (?) and review
  • Feynman
  • Pomodoro

Add theme data

As a

dev

I want to

have a themeData for light and dark theme

To

easily change the app theme


Acceptance Criteria

  • have app_theme.dart under theme/
  • have text_styles.dart under theme/
  • have text_theme.dart under theme/
  • plugged the theme on main app

Add Blurting Method

Warning

Most are tentative

  • cannot be suggested in reco
  • will be asked to choose what notebook and new page
  • tell to write whatever comes to mind with the chosen topic
  • tell that do not worry with categorizing
  • after some time, ask if done
  • if yes, the app will organize it and add more details about the topic
  • tell to review the new content and take a quiz after

Review state provider is not null if pressed back from quiz

Pressing back from quiz all the way back to the review methods fails because app thinks user came from analyze notes which needs to pre-fill the pop-up.

fix: need to reset review state provider on press back from feynman (maybe other learning methods also)

Addd PQ4R

Warning

Most are tentative

  • tell to review the notes
  • after some time, ai formulate questions
  • tell to re read the material while answering the questions
  • tell to reflect for a moment, and give guide questions for them to reflect on.
  • tell to recite the information into own words
  • tell to go bac to review to revise understanding
  • if goods quiz, otherwise repeat.

Add SQ3R

Warning

Most are tentative

  • review the notes
  • after some time, ai formulate questions
  • tell to re read the material while answering the questions
  • tell to recite the information into own words
  • tell to go bac to review to revise understanding
  • if goods quiz, otherwise repeat.

Add localization

As a

user

I want to

have a language choice

To

make it more accessible to me


Acceptance Criteria

  • working Filipino translations

Add user tour on first login

As a

user

I want to

get a tour of how to use the note-taking feature

To

get started


Acceptance Criteria

  • a tour showing how to add notebook, then how to add a note
  • store in the users field if that user has done the tour

Add expiration to old sessions

This is to avoid clogging the UI when there are too many old sessions.

Tip

OR JUST MAKE THE DIALOG SCROLLABLE PLUS WITH SEARCH OR JUST MAKE THE DIALOG SCROLLABLE PLUS WITH SEARCH

Leitner

  • can make the score and remark an array so that when the student has consecutive good scores and remarks, we can have longer next_review

Feynman

  • can have expiration of old sessions or just archive it (not delete completely)

Reduce splash screen animation

I think 5 secs is too long, tried changing the delay on the splash_screen file but the animation will not finish by the time stops

Project initialization

As a

dev

I want to

initialize the project

To

kickstart the mvp development


Acceptance Criteria

  • initialized project

Data analysis

As a

user

I want to

see what learning technique I excel in and I struggle with.

To

track my progress


Acceptance Criteria

  • working data analytics page
  • dialog that shows the user's strength, and suggests other learning techniques, this can be shown at intervals so that the user won't get annoyed every time he opens the data analytics fragment

Add how many learning methods used in a subject/notebook

As a

user

I want to

see my progress in each notebook

To

see what methods I need to focus more on (analytics screen)


Acceptance Criteria

  • add a new map in notebooks property
  • with each item correspond to the number of times of the method usage

Add implementaion of Leitner System

As a

user

I want to

use the leitner system review method

To

review using flashcards


Acceptance Criteria

  • can generate flashcards
  • can update remark and score
  • have separate page for reviewing leitner system
  • record response time for each flashcard

Add Active Recall

Warning

Most are tentative

  • tell to study the note
  • go back in the next 2 hrs
  • a textfield to input what the student have remembered without looking in that note
  • regardless of result (will still show), take a quiz

Add acronym mnemonics

Warning

Most are tentative

  • cannot be suggested in reco
  • this will check in a note if it is possible to use
  • if yes, quiz using those acronyms with the correct meaning
  • otherwise show not applicable
  • allow reviewing of quiz

Add elaboration

Warning

Most are tentative

  • elaborate the students note
  • tell to review, once done quiz

Complete ui design of study methods

As a

dev

I want to

see the ui/ux of each study methods

To

plan how are we going to do it


Acceptance Criteria

  • finished ui/ux of each study methods
  • working prototype
  • features intro

Note analyzer

As a

user

I want to

the app to analyze my notes to get what my notes are about

To

have more context about the note


Acceptance Criteria

  • analyze notes context
  • analyze note on interval (once a day per note)
  • analyze if the note is urgent thus having a high priority making that note appear at the top. (using sentiment analysis -ma'am) (but I'll try prompt engineering first)
  • recommend a learning technique based on the notes
  • the recommended learning technique should be the topmost technique on the list
  • show a tour on how to get started with learning techniques

Add an enum for firestore collections

As a

dev

I want to

have an enum where i can just call enum.collectionName

To

make it easy to change when the collection's name changed


Acceptance Criteria

  • have an enum file under core/ named firestore_collection_enum.dart

Add implementation of Pomodoro Technique

As a

user

I want to

use the pomodoro technique

To

to beat my procrastination ashah


Acceptance Criteria

  • the timer should not stop when the user leaves the screen or the app (?)
  • a notification should be shown when the timer stops
  • basic functionality of the pomodoro technique ( pause timer, continue, the sets etc.)

Note taking page

As a

user

I want to

have a notes page, to be able to create notes and etc.

To

use the review methods


Acceptance Criteria

  • creation of notes by typing
  • scanning written notes ( take pic or from gallery)
  • scanning digital notes (via upload)
  • creation of notes from speech
  • creation of subjects/folder
  • ability to choose notebook cover photo
    • creation of notes inside that subject/folder
  • search for keywords on all notes (?)

Add app's homepage

As a

user

I want to

see the homepage with the bottom navbar

To

use easily navigate the app


Acceptance Criteria

  • is using a shared homepage screen
  • working bottom navbar
  • using shared firestore provider (if needed)

Add app constants

As a

dev

I want to

have a constants file where I can access the colors and fonts

To

have easy access


Acceptance Criteria

  • constants is on lib/core/shared/theme/

Add settings screen

As a

user

I want to

see the settings screen

To

to configure the app to my preferences


Acceptance Criteria

  • Allow changing of theme
  • Allow changing of language
  • Allow sign out
  • Allow deleting of account
  • TBA

Add a landing page

As a

user

I want to

see an overview of the learning methods

To

know what to do with those


Acceptance Criteria

  • Landing page on very first login

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.