From 63cf27c1cba67b33b49a8332b5c13dd6d5967472 Mon Sep 17 00:00:00 2001 From: NiBa97 Date: Sun, 7 Apr 2024 20:47:58 +0200 Subject: [PATCH 1/3] docs: Add first version of the analysis user story --- wiki/user_stories/analysis.drawio.svg | 341 ++++++++++++++++++++++++++ wiki/user_stories/index.md | 20 ++ 2 files changed, 361 insertions(+) create mode 100644 wiki/user_stories/analysis.drawio.svg create mode 100644 wiki/user_stories/index.md diff --git a/wiki/user_stories/analysis.drawio.svg b/wiki/user_stories/analysis.drawio.svg new file mode 100644 index 0000000..113367b --- /dev/null +++ b/wiki/user_stories/analysis.drawio.svg @@ -0,0 +1,341 @@ + + + + + + + + + + + + + + + + + + +
+
+
+ Transactions +
+
+
+ + + Transactions + + + + + + + + +
+
+
+ + Filter + +
+
+
+ + + Filt... + + + + + + + +
+
+
+ (4) Selected +
+
+
+ + + (4) Selected + + + + + + + +
+
+
+ Time range +
+
+
+ + + Time range + + + + + + + +
+
+
+ Categories +
+
+
+ + + Categories + + + + + + + + + + +
+
+
+ + Time range XXXX -- YYYY + +
+
+
+ + + Time range XXXX -- YYYY + + + + + + + +
+
+
+ + XXXX + + + total transactions + +
+
+
+ + + XXXX total transactions + + + + + + + +
+
+
+ + XXXX + + + + + total received + +
+
+
+ + + XXXX total received + + + + + + + +
+
+
+ + XXXX + + + + + total spend + +
+
+
+ + + XXXX total spend + + + + + + + +
+
+
+ + Transactions by time (and category) + +
+
+
+ + + Transactions by time (and category) + + + + + + + + +
+
+
+ + Spending by Category + +
+
+
+ + + Spending by Category + + + + + + + + +
+
+
+
    +
  • + All spendings +
    • +
  • + Grouped by day, week or month +
    • +
  • + Colorized by category +
    • +
  • + Full width for maximal visibility +
    • +
+
+
+
+ + + All spendingsGrouped by d... + + + + + + + +
+
+
+
    +
  • + Pie Chart for all categories +
    • +
  • + Also clear text spendings of each category for easy readability +
    • +
+
+
+
+ + + Pie Chart for all categoriesAlso... + + + + + + + +
+
+
+ + Transaction List + +
+
+
+ + + Transaction List + + + + + + + +
+
+
+
+ Re-usable table component to list the current selection of transaction and modify them if necessary. +
+
+ Filter selection should be disabled (as thats covered on top of the transaction page), but searching for clear text and sorting should still be possible +
+
+
+
+ + + Re-usable table component to list the current selection of transaction and modify them if n... + + + + + + + + + Text is not SVG - cannot display + + + + \ No newline at end of file diff --git a/wiki/user_stories/index.md b/wiki/user_stories/index.md new file mode 100644 index 0000000..da105f9 --- /dev/null +++ b/wiki/user_stories/index.md @@ -0,0 +1,20 @@ +# User Stories + +This is a collection of user stories. It's meant to be flexible over time; accordingly, the list below is not ordered. + +## Analyze + +As an End User, I want to see what I spend my money on in the selected time period. + +Acceptance Criteria: + +- [ ] Selectable time period +- [ ] Selection of graphs for a quick overview +- [ ] Ability to filter transactions based on category +- [ ] Ability to list transactions in a tabular view +- [ ] Summary numbers at the top + +
+ Mock-up + Mockup of the Analyze Story +
From 0b1d3dc37b7479bc2b218de06ee064d983cca36c Mon Sep 17 00:00:00 2001 From: NiBa97 Date: Sun, 7 Apr 2024 20:47:43 +0200 Subject: [PATCH 2/3] ci: Add wiki linter --- .github/workflows/wiki-lint.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .github/workflows/wiki-lint.yml diff --git a/.github/workflows/wiki-lint.yml b/.github/workflows/wiki-lint.yml new file mode 100644 index 0000000..7537260 --- /dev/null +++ b/.github/workflows/wiki-lint.yml @@ -0,0 +1,19 @@ +name: Lint Markdown + +on: + pull_request: + paths: + - 'wiki/**' + workflow_dispatch: + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Markdown lint + uses: DavidAnson/markdownlint-cli2-action@v15 + with: + globs: 'wiki/**/*.md' \ No newline at end of file From b53bbdd90997a1b753dd20b5f8355896293d22bd Mon Sep 17 00:00:00 2001 From: NiBa97 Date: Sun, 14 Apr 2024 09:36:53 +0200 Subject: [PATCH 3/3] refactor: Fix markdown issues --- package.json | 5 +++++ wiki/home.md | 2 ++ wiki/user_stories/index.md | 3 ++- 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index dbaf9cb..731a40f 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,11 @@ "lint": "next lint", "start": "next start" }, + "markdownlint-cli2": { + "config": { + "MD033": false + } + }, "dependencies": { "@chakra-ui/react": "^2.8.2", "@emotion/react": "^11.11.3", diff --git a/wiki/home.md b/wiki/home.md index 912460d..168f4fd 100644 --- a/wiki/home.md +++ b/wiki/home.md @@ -1 +1,3 @@ +# Home + First wiki entry. diff --git a/wiki/user_stories/index.md b/wiki/user_stories/index.md index da105f9..b47d45a 100644 --- a/wiki/user_stories/index.md +++ b/wiki/user_stories/index.md @@ -1,6 +1,7 @@ # User Stories -This is a collection of user stories. It's meant to be flexible over time; accordingly, the list below is not ordered. +This is a collection of user stories. +It's meant to be flexible over time; accordingly, the list below is not ordered. ## Analyze