95 lines
2.8 KiB
Markdown
95 lines
2.8 KiB
Markdown
\## Overview
|
|
|
|
|
|
|
|
This is a PWA (that requires internet access for database functionality) designed to help a user stay organized. It is an extended to-do list and notes organizer. We may expand it later to include AI interrogation of notes capabilities etc. -- but that will be later.
|
|
|
|
|
|
|
|
\## Platform
|
|
|
|
|
|
|
|
\- Hostable from a docker-compose.yml file.
|
|
|
|
  - All volumes should be local filesystem volumes, not docker volumes.
|
|
|
|
\- Postgres DB
|
|
|
|
\- Next JS
|
|
|
|
\- Open to other suggestions
|
|
|
|
|
|
|
|
\## UI Layout
|
|
|
|
|
|
|
|
\### Menu
|
|
|
|
|
|
|
|
Left Side menu bar - expands and contracts.
|
|
|
|
|
|
|
|
\- Contracted view shows icons with hovers - still interactive
|
|
|
|
\- Expanded view shows icons with text
|
|
|
|
\- To begin with the only icon/text item on the menu is "Home"
|
|
|
|
|
|
|
|
\### Home
|
|
|
|
|
|
|
|
Primary path of the site presets and overview of all existing Categories, Groups, Notes and To-Dos.
|
|
|
|
|
|
|
|
\- Notes and To-Dos are children of Groups
|
|
|
|
\- Groups are children of Categories
|
|
|
|
\- Categories are the parent of how things are organized.
|
|
|
|
|
|
|
|
On the main page view, visually organize in the following manner:
|
|
|
|
|
|
|
|
\- Categories - Should be organized similar to Kanban Style
|
|
|
|
  - The typical Kanban headers like "Ready" or "In-Progress" instead should be the Category names
|
|
|
|
  - The "cards" inside the lanes will be the "groups". The user should be able to drag and drop cards between Categories, changing their category when they do.
|
|
|
|
  - The furthest right lane should be a "+ Add Category" lane, and when clicked on a new Category can be created.
|
|
|
|
\- Groups - The cards within the Kanban/Category lanes
|
|
|
|
  - A group should be a card. Cards consist of a Notes icon and a to-do list, and an "+" symbol at the bottom to add a to-do.
|
|
|
|
  - At the bottom of the cards in each row should be a "+ Group" which allows a new group to be created via a pop over window.
|
|
|
|
  - When creating a group, allow a short title <20 characters.
|
|
|
|
  - Also allow a Color to be selected from a diverse pool of vibrant colors from the same aesthetic family (meaning colors that don't clash horribly).
|
|
|
|
  - The card/group should have a thick stroke in the color it was created with.
|
|
|
|
\- Notes
|
|
|
|
  - The notes icon, when clicked, should show a pop over window that has any notes collected on the Group as well as the ability to edit those notes. The editing format should be a markdown editor, and the notes displayed and editable in a pretty manner.
|
|
|
|
\- To-Dos
|
|
|
|
  - On the main page, the user has the ability to check the box next to the to-do, completing it by strikethrough, as well as clicking a completed to-do to uncomplete it. If the words are clicked on then a pop over window should allow the user to edit the to-do title (less than 20 char) and a "details" field with notes about the to-do.
|
|
|
|
  - The + symbol at the bottom of the group allows the user to create a new To-Do in a pop over window.
|
|
|