From 0ca9993cd60456ec4a48c46c0ee7cdd68bd97df0 Mon Sep 17 00:00:00 2001 From: Abhay Menon <abhay.menon@uwaterloo.ca> Date: Mon, 10 Apr 2023 03:27:48 -0400 Subject: [PATCH] Updated markdown documentation files --- README.md | 50 ++++++++++++++++++++++++---------- meeting-minutes/ds/20230326.md | 28 +++++++++++++++++++ meeting-minutes/ds/20230401.md | 29 ++++++++++++++++++++ meeting-minutes/ds/20230406.md | 28 +++++++++++++++++++ meeting-minutes/ds/20230409.md | 28 +++++++++++++++++++ meeting-minutes/mm/20230405.md | 27 ++++++++++++++++++ meeting-minutes/mm/20230409.md | 31 +++++++++++++++++++++ release-notes/2.0.0.md | 4 +-- release-notes/3.0.0.md | 2 +- release-notes/4.0.0.md | 29 ++++++++++++++++++++ 10 files changed, 238 insertions(+), 18 deletions(-) create mode 100644 meeting-minutes/ds/20230326.md create mode 100644 meeting-minutes/ds/20230401.md create mode 100644 meeting-minutes/ds/20230406.md create mode 100644 meeting-minutes/ds/20230409.md create mode 100644 meeting-minutes/mm/20230405.md create mode 100644 meeting-minutes/mm/20230409.md create mode 100644 release-notes/4.0.0.md diff --git a/README.md b/README.md index 0d5f637..e4099ca 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ <h1 align="center"> <br> - <img src="logo.png" alt="GoodNote" width="200"></a> + <img src="logo.png" alt="Sticky Note" width="200"></a> <br> - GoodNote + Sticky Note <br> </h1> @@ -21,25 +21,36 @@  ## Goal -**GoodNote** is a simple and easy-to-use note-taking application with many features supported. This is a project from team 112 of CS 346: Application development. +**Sticky Note** is a simple and easy-to-use note-taking application with many features supported. This is a project from team 112 of CS 346: Application development. ## Features #### Main features include: - A top-level menu bar that lists major functions, and indicates the hotkeys for each feature (e.g. File, Edit, View menu and submenus). - Toolbars that let the user control settings and modes that apply to the application e.g. a Bold button that can be used to embolden text, and reflects the state of selected text. -- Window resizing, so that the user can resize and reposition the application. You should save the window size and position on exit, and restore that size and position when they relaunch it. -- Minimize/mazimize buttons function as expected. +- Minimize/maximize buttons function as expected. - Undo-redo support for actions in the user interface. - Cut-copy-paste text. +- Create, edit, delete note +- Display a list of locally and remotely saved notes +- Rich text support for the note body (e.g., font style, size, face, and highlight support) +- Support for bullet points #### Additional features: -- Create, edit, delete a note (using both keyboard and point-click). -- Group related notes together e.g. folders or tags. Support add/delete and rename groups, and move notes between groups. -- Support for bulleted lists, including the ability to apply or remove bullets from a block of selected text. +- Notes explorer window +- Multiple note windows +- Remote database synchronization +- Dark/Light Theme support +- Image Support +- Command Line Support + +## Microservices: +This notes application makes use of the microservices architecture for storing notes and images +- [Notes Microservice](https://git.uwaterloo.ca/a32menon/notes-app-backend) +- [Image Microservice](https://git.uwaterloo.ca/a32menon/notes-app-image) ## Installation - - +- To install Sticky Notes, simply head over to Software Releases and unzip one of our many releases (Sprint 4 being the latest) +- Once the file has been installed and unzipped, the app can be executed by going to the `bin/` directory and running the `./app` command ## Technologies This project uses the following technologies: @@ -48,7 +59,8 @@ This project uses the following technologies: - [GitLab](https://about.gitlab.com/) for project tracking. - [JavaFX](https://openjfx.io/) for the graphical user-interface. - [SQLite](https://www.sqlite.org/index.html) for managing local storage. -- [H2](https://www.h2database.com/html/main.html) for remote data storage. +- [Spring](https://spring.io/) for creating the web service. +- [Amazon Elastic Cloud Compute](https://aws.amazon.com/) for hosting the Spring web service. - [JUnit](https://junit.org/junit5/) for testing. - [Gradle](https://gradle.org/) for project builds. @@ -62,14 +74,22 @@ This project uses the following technologies: ## Releases -> V**ersion 1.0.0**: Infrastructure & GUI (released Feb 17, 2023) -> * [release-notes (md)](releases/v1.0.0-release-notes.md) +> **Version 1.0.0**: Infrastructure & GUI (released Feb 17, 2023) +> * [release-notes (md)](release-notes/1.0.0.md) > * installer (Window, MacOS) >**Version 2.0.0**: Data Persistance (released Mar 10, 2023) -> * release-notes (md) +> * [release-notes (md)](release-notes/2.0.0.md) +> * installer (Window, MacOS) + +> **Version 3.0.0**: Infrastructure & GUI (released Mar 24, 2023) +> * [release-notes (md)](release-notes/3.0.0.md) > * installer (Window, MacOS) -## License +>**Version 4.0.0**: Wrapup (released Apr 10, 2023) +> * [release-notes (md)](release-notes/4.0.0.md) +> * installer (Window, MacOS) +## License +- [MIT License](LICENSE) --- diff --git a/meeting-minutes/ds/20230326.md b/meeting-minutes/ds/20230326.md new file mode 100644 index 0000000..864e716 --- /dev/null +++ b/meeting-minutes/ds/20230326.md @@ -0,0 +1,28 @@ +# CS 346: Daily Standup + +| Date | Team # | +|:----------:| :----: | +| 2023-03-26 | 112 | + +## Questions + +_Enter comments below. If a team member is absent, fill in their name, and put a line through the answer section_ + +| Name | What have you completed since last meeting? | What are you going to complete today? | What obstacles are in your way? | +| --------------- |--------------------------------------------------------------|---------------------------------------|------------------------------------------------| +| Abhay Menon | Setting up Spring web service for #48 | - | - | +| Inseo Kim | #49 | Testing #49, UI changes for #48 | Waiting for Abhay's and Hoang's changes to #48 | +| Hoang Dang | Setting up notes-app for #48 (HTTP Methods & business logic) | - | - | +| Guransh Khurana | - | #25, Helping Anshul with #24 | - | +| Anshul Ruhil | - | #24 | - | + +## Outstanding + +_Do we need help with anything?_ + +No +## Decisions + +_Is there anything else we should capture from this meeting?_ + +No \ No newline at end of file diff --git a/meeting-minutes/ds/20230401.md b/meeting-minutes/ds/20230401.md new file mode 100644 index 0000000..6d8703b --- /dev/null +++ b/meeting-minutes/ds/20230401.md @@ -0,0 +1,29 @@ +# CS 346: Daily Standup + +| Date | Team # | +|:----------:| :----: | +| 2023-04-01 | 112 | + +## Questions + +_Enter comments below. If a team member is absent, fill in their name, and put a line through the answer section_ + +| Name | What have you completed since last meeting? | What are you going to complete today? | What obstacles are in your way? | +| --------------- |---------------------------------------------|------------------------------------------------------------------------------------------------|------------------------------------------------| +| Abhay Menon | | Working on #48; trying to set up auto-deploy from CI/CD | - | +| Inseo Kim | #49 | Helping Anshul and Guransh with #24; helping Abhay and Hoang with business logic for data sync | Waiting for Abhay's and Hoang's changes to #48 | +| Hoang Dang | | Working on #48 with Abhay; trying to figure out business logic for data sync | - | +| Guransh Khurana | - | #25, Helping Anshul with #24 | - | +| Anshul Ruhil | - | #24 | - | + +## Outstanding + +_Do we need help with anything?_ + +We might require help from Jeff or a TA for data synchronization but we will try alternate approaches to our original business logic and see if they work. +## Decisions + +_Is there anything else we should capture from this meeting?_ + + +We need to consider if we need the data synchronization feature since it is taking a lot of time. We need to make room for the image support feature. \ No newline at end of file diff --git a/meeting-minutes/ds/20230406.md b/meeting-minutes/ds/20230406.md new file mode 100644 index 0000000..1d3d680 --- /dev/null +++ b/meeting-minutes/ds/20230406.md @@ -0,0 +1,28 @@ +# CS 346: Daily Standup + +| Date | Team # | +|:----------:| :----: | +| 2023-04-06 | 112 | + +## Questions + +_Enter comments below. If a team member is absent, fill in their name, and put a line through the answer section_ + +| Name | What have you completed since last meeting? | What are you going to complete today? | What obstacles are in your way? | +| --------------- |---------------------------------------------|----------------------------------------------|---------------------------------| +| Abhay Menon | #48 | Testing #48 | - | +| Inseo Kim | #49, #48 | Fixing bugs that has arisen from testing #48 | - | +| Hoang Dang | #48 | Testing #48 | - | +| Guransh Khurana | - | #25 | - | +| Anshul Ruhil | - | #24 | - | + +## Outstanding + +_Do we need help with anything?_ + +We no longer need help with #48. This issue has been solved! :D +## Decisions + +_Is there anything else we should capture from this meeting?_ + +We need to test #48 thoroughly due to the sheer importance of the feature. \ No newline at end of file diff --git a/meeting-minutes/ds/20230409.md b/meeting-minutes/ds/20230409.md new file mode 100644 index 0000000..72ea022 --- /dev/null +++ b/meeting-minutes/ds/20230409.md @@ -0,0 +1,28 @@ +# CS 346: Daily Standup + +| Date | Team # | +|:----------:| :----: | +| 2023-04-09 | 112 | + +## Questions + +_Enter comments below. If a team member is absent, fill in their name, and put a line through the answer section_ + +| Name | What have you completed since last meeting? | What are you going to complete today? | What obstacles are in your way? | +| --------------- |---------------------------------------------|---------------------------------------|-------------------------------------------------------------------------------------------------------| +| Abhay Menon | - | #50 (Immediate requirement), #51 | Completion of #50; resolving all merge conflicts, updating documentation files, creating presentation | +| Inseo Kim | #49, #48 | Helping Abhay resolve merge conflicts | - | +| Hoang Dang | #48 | Helping Abhay resolve merge conflicts | - | +| Guransh Khurana | - | #25 | - | +| Anshul Ruhil | #24 | - | - | + +## Outstanding + +_Do we need help with anything?_ + +No +## Decisions + +_Is there anything else we should capture from this meeting?_ + +If we do not manage to finish the image support feature on time, we will consider skipping it due to time constraints. \ No newline at end of file diff --git a/meeting-minutes/mm/20230405.md b/meeting-minutes/mm/20230405.md new file mode 100644 index 0000000..6b30d8d --- /dev/null +++ b/meeting-minutes/mm/20230405.md @@ -0,0 +1,27 @@ +# CS 346: Meeting Minutes + +| Date | Team # | +|:----------:| :----: | +| 2023-04-05 | 112 | + +**Present:** Abhay Menon, Inseo Kim, Hoang Dang +<br/> +**Absent:** Guransh Khurana, Anshul Ruhil + +--- + +## Agenda +- Figure out a way to implement data synchronization + +## Notes +- Our initial plan to implement this feature was to have a "lastSaved" record for the local and remote database and basically replace the entirety of the oldest database with the newest database +- We realize that this could mean that all the old data will be deleted +- This could lead to a problem if a new user makes a single note; all the older notes would get deleted + +## Decisions +- Inseo suggested that we could instead allow the users to selectively choose if they would like to update the remote database (thereby updating the remote entry) or fetch the remote data (thereby updating the local entry) +- We observed no problems with this approach and have decided to go with this implementation + +## Actions +- Inseo worked on the GUI features needed to implement this additional feature of synchronizing data +- Hoang and Abhay worked on providing Inseo with the necessary methods to make data synchronization possible \ No newline at end of file diff --git a/meeting-minutes/mm/20230409.md b/meeting-minutes/mm/20230409.md new file mode 100644 index 0000000..ceab277 --- /dev/null +++ b/meeting-minutes/mm/20230409.md @@ -0,0 +1,31 @@ +# CS 346: Meeting Minutes + +| Date | Team # | +|:----------:| :----: | +| 2023-04-09 | 112 | + +**Present:** Abhay Menon, Guransh Khurana, Inseo Kim, Hoang Dang, Anshul Ruhil +<br/> +**Absent:** - + +--- + +## Agenda +- Add image functionality (with the help of a microservice) +- Fix the bug (where a new file is saved as "Untitled") in the console-support branch +- Resolve any possible merge conflicts + +## Notes +- When the theme feature was tested, we noticed some errors in the dialog boxes. Anshul said that he did not know how to change the css of the dialog box contents. + Normally, we would look into this more but seeing as we did not have a lot of time left. We remote dark themes from the dialog box and only implemented it in the note + window and the notes explorer window. +- We managed to create the microservice just in time +- Inseo and Hoang helped Abhay in resolving all the merge conflicts/bugs that arose from merging all the additional features into main + +## Decisions +- We will not be implementing the image resize feature and will be removing themes from the dialog boxes + +## Actions +- All additional features merged +- Resolved all merge conflicts +- Added image support feature (#25 and #50) \ No newline at end of file diff --git a/release-notes/2.0.0.md b/release-notes/2.0.0.md index 2713d98..c1df019 100644 --- a/release-notes/2.0.0.md +++ b/release-notes/2.0.0.md @@ -1,5 +1,5 @@ -# Team 112's Notes Application (Release 1.0.0) -> _Date: February 17, 2023_ +# Team 112's Notes Application (Release 2.0.0) +> _Date: March 10, 2023_ ## 🚀 What's New diff --git a/release-notes/3.0.0.md b/release-notes/3.0.0.md index 3c0a0bf..8fc4a20 100644 --- a/release-notes/3.0.0.md +++ b/release-notes/3.0.0.md @@ -1,5 +1,5 @@ # Team 112's Notes Application (Release 3.0.0) -> _Date: February 23, 2023_ +> _Date: March 24, 2023_ ## 🚀 What's New diff --git a/release-notes/4.0.0.md b/release-notes/4.0.0.md new file mode 100644 index 0000000..18019d2 --- /dev/null +++ b/release-notes/4.0.0.md @@ -0,0 +1,29 @@ +# Team 112's Notes Application (Release 4.0.0) +> _Date: April 10, 2023_ + +## 🚀 What's New + +### 📈 Changelog +- Notes explorer window +- Multiple note windows +- Remote synchronization +- Dark/Light Theme +- Image Support +- Command Line Support + + +### 💅 UI Changes + +- Created Local and remote note explorer window using JavaFX +- Added multiple window feature using JavaFX +- Added dark/light theme functionality using JavaFX and CSS +- Added command line support +- Enabled image support for the notes application + +### 👩â€ðŸ’» Backend Changes +- Updated backend Spring web service to support remote data synchronization +- Created a Spring microservice to store images remotely + +## 🞠Bug Fixes +- Limited HTMLTextArea height + -- GitLab