Skip to content

Commit 1e26e27

Browse files
JeepWayJeepWay
committed
Style: remove calander from view
Remove SwingCalander.java from view folder. Modify README.
1 parent 92668d5 commit 1e26e27

File tree

5 files changed

+229
-147
lines changed

5 files changed

+229
-147
lines changed

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
*.class
22
/target/
33
/build/
4+
/bin/
45
.classpath
56
.settings
67
.vscode

‎MoneyTrackerTour.en-US.md

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# MoneyTracker Tour
2+
<p align=center>
3+
<a href="MoneyTrackerTour.en-US.md">English&nbsp;&nbsp;</a>
4+
<a href="MoneyTrackerTour.zh-TW.md">繁體中文</a><br>
5+
</p>
6+
7+
> If there are any issues with missing instructions, feel free to leave a comment for discussion.
8+
## Login Page Instructions
9+
![](https://hackmd.io/_uploads/SJrZDbZIn.png)
10+
11+
* On the right side of this page, enter your Username in the <font color="#f00">red box</font>.
12+
* On the right side of this page, enter your Password in the <font color="#FF8D33">orange box</font>.
13+
* Click the button in the <font color="#3377FF">blue box</font> to display the Password.
14+
* Then click the <font color="#f00">red LOG IN button</font> to log in.
15+
* If you do not have an account, click the <font color="#3377FF">blue SIGN UP button</font> to go to the [registration page](#Sign-up-page-instructions).
16+
17+
---
18+
19+
## Sign-up Page Instructions
20+
![](https://hackmd.io/_uploads/B1vKY--In.png)
21+
* On the right side of this page, enter your Username.
22+
* <font color="#f00">Note: Your Username will be used for future logins.</font>
23+
* On the right side of this page, enter your Email.
24+
* On the right side of this page, enter your Phone number.
25+
* On the right side of this page, enter your Password.
26+
* <font color="#f00">Note: Your Password will be used for identity verification during future logins.</font>
27+
* Click [Show Password] to display the characters of your Password.
28+
* After completing the data entry, click the <font color="#f00">red SIGN UP button</font>, and after successful registration, you will be guided to the login page.
29+
* If you already have an account, click the <font color="#3377FF">blue LOG IN button</font> to go to the [login page](#Login-page-instructions).
30+
31+
:::warning
32+
**Possible issues:** Please follow the instructions in the pop-up prompt.
33+
1. Username, Email, Phone number, Password not entered.
34+
2. Invalid characters entered.
35+
* For the Email field, please enter a complete email address including the @ symbol.
36+
* The Phone field only accepts numbers.
37+
4. Registration data has been used.
38+
* Username, Email, Phone number, Password must <font color="#f00">not be duplicated</font>; please ensure you have not registered before.
39+
:::
40+
41+
---
42+
43+
## Dashboard Page Instructions
44+
45+
![](https://hackmd.io/_uploads/B1FkV7fU3.png)
46+
* This page will default to displaying this month's statistics.
47+
* The Expense field will display this month's total expenses.
48+
* The Income field will display this month's total income.
49+
* The Balance field will display this month's balance (total income - total expenses).
50+
* To view statistics for other months, select the month from the Select Month dropdown menu, and choose the year from the Select Year dropdown menu.
51+
* If you need a statistics table that includes time, please go to the [History page](#History-page-instructions).
52+
53+
---
54+
55+
## History Page Instructions
56+
![](https://hackmd.io/_uploads/rJC0PmMLh.png)
57+
* This page will display your recorded expenses & income.
58+
* At the top, you can select the month, year, and category (income/expenses/all) from the dropdown menus, then click the Search button to display the data in the table below.
59+
* If you need to [modify](#modify-records), [delete](#delete-records), or [clear selected records](#clear-selected-items), please refer to the links.
60+
61+
### Modify Records
62+
To modify records, please follow these steps:
63+
1. Click on the item you want to modify in the table.
64+
2. In the Modify area at the bottom, the item you clicked will be displayed, and you can click on the item you want to modify.
65+
* For the Date field, refer to the [date entry instructions](#date-entry-instructions).
66+
4. After making changes, click the Modify button.
67+
### Delete Records
68+
To delete records, please follow these steps:
69+
1. Click on the item you want to delete in the table.
70+
2. In the Modify area at the bottom, the item you clicked will be displayed, click the Delete button to remove it.
71+
### Clear Selected Items
72+
To clear selected items, please follow these steps:
73+
1. In the Modify area at the bottom, the items you have currently selected will be displayed, and you can click the Refresh button to deselect them.
74+
75+
---
76+
77+
## AddExpense Page Instructions
78+
![](https://hackmd.io/_uploads/BkLQ1EM8h.png)
79+
80+
* Select the category of the expense from the Category dropdown menu.
81+
* For the Date field, refer to the [date entry instructions](#date-entry-instructions).
82+
* Directly enter the amount in the Amount field, limited to <font color="#f00">numbers only</font>.
83+
* The Detail field can contain any details or notes about this expense.
84+
* If you need to add an income item, refer to the [AddIncome page instructions](#AddIncome-page-instructions).
85+
86+
---
87+
## AddIncome Page Instructions
88+
![](https://hackmd.io/_uploads/BJzFamzLn.png)
89+
* Select the category of the income from the Category dropdown menu.
90+
* For the Date field, refer to the [date entry instructions](#date-entry-instructions).
91+
* Directly enter the amount in the Amount field, limited to <font color="#f00">numbers only</font>.
92+
* The Detail field can contain any details or notes about this income.
93+
* If you need to add an expense item, refer to the [AddExpense page instructions](#AddExpense-page-instructions).
94+
95+
---
96+
97+
## Date Entry Instructions
98+
![](https://hackmd.io/_uploads/SJsW27fLh.png)
99+
* As an example, on the AddExpense page
100+
* Click the small calendar button on the right to pop up the date options, and simply click on a date to automatically fill in the date.

‎MoneyTrackerTour.zh-TW.md

+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# MoneyTracker導覽
2+
<p align=center>
3+
<a href="MoneyTrackerTour.en-US.md">English&nbsp;&nbsp;</a>
4+
<a href="MoneyTrackerTour.zh-TW.md">繁體中文&nbsp;&nbsp;</a>
5+
</p>
6+
7+
> 若有指引未撰寫之問題，歡迎留言討論
8+
9+
## Login頁面指引
10+
![](https://hackmd.io/_uploads/SJrZDbZIn.png)
11+
12+
13+
* 可於本頁面右側<font color="#f00">紅框</font>處輸入註冊時的 Username
14+
* 可於本頁面右側<font color="#FF8D33">橘框</font>處輸入註冊時的 Password
15+
* 可點選<font color="#3377FF">藍框</font>處的按鈕顯示 Password
16+
* 再點選<font color="#f00">紅色 LOG IN 按鈕</font> 即可登入
17+
* 若尚未擁有帳號，則可點選<font color="#3377FF"> 藍色 SIGN UP 按鈕</font> 進入 [註冊頁面](#Sign-up頁面指引)
18+
19+
20+
---
21+
22+
## Sign-up頁面指引
23+
![](https://hackmd.io/_uploads/B1vKY--In.png)
24+
* 可於本頁面右側輸入您的的 Username
25+
* <font color="#f00">注意：Username 將做為以後登入時辨識身分使用</font>
26+
* 可於本頁面右側輸入您的的 Email
27+
* 可於本頁面右側輸入您的的 Phone number
28+
* 可於本頁面右側輸入您的的 Password
29+
* <font color="#f00">注意：Password 將做為以後登入時驗證身分使用</font>
30+
* 可點選[Show Password] 顯示 Password的字元
31+
* 完成資料填寫後，可點選<font color="#f00">紅色 SIGN UP 按鈕</font>，註冊成功後將會導引您至登入頁面
32+
* 若已有帳號，可點選 <font color="#3377FF"> 藍色 LOG IN 按鈕</font> 進入 [登入頁面](#Login頁面指引)
33+
34+
:::warning
35+
**可能出現的狀況：** 請依照彈出提示框指示輸入
36+
1. Username、Email、Phone number、Password 未輸入
37+
2. 輸入非法字元
38+
* Email欄位請輸入包含 @ 的完整郵件地址
39+
* Phone欄位僅接受數字
40+
4. 註冊的資料已被使用
41+
* Username、Email、Phone number、Password 皆<font color="#f00">不得重複</font>，請確定您是否曾經註冊過
42+
:::
43+
44+
45+
---
46+
47+
## DashBoard頁面指引
48+
49+
![](https://hackmd.io/_uploads/B1FkV7fU3.png)
50+
* 本頁將預設顯示本月的統計表格
51+
* Expense 欄位將顯示本月的總花費
52+
* Income 欄位將顯示本月的總收入
53+
* Balance 欄位將顯示本月的餘額 (總收入-總花費)
54+
* 若需查看它月的統計，可於 Select Month 下拉式選單選擇月份統計，並於Select year 下拉式選單選擇年分
55+
* 若須有包含時間的統計表，請至[History頁面](#History頁面指引)操作
56+
57+
58+
---
59+
60+
## History頁面指引
61+
![](https://hackmd.io/_uploads/rJC0PmMLh.png)
62+
* 本頁將顯示您曾經記錄過的支出&收入
63+
* 於最上方三個下拉式選單可以分別選擇 月份、年分、收入/支出/所有類別，選擇完後點選 Search按鈕，即會將資料顯示於下方表格
64+
* 若需[變更](#變更紀錄)/[刪除](#刪除紀錄)/[清除選取紀錄](#清除所選項目)，請參考連結
65+
66+
### 變更紀錄
67+
若需變更紀錄，請參考以下步驟：
68+
1. 於表格內點選所需的變更的項目
69+
2. 於最下方的Modify區域將會顯示您所點選的項目，並可點選所需變更的項目進行更改
70+
* Date欄位輸入可參考[日期輸入指引](#日期輸入指引)
71+
4. 變更完成後可點選Modify按鈕
72+
### 刪除紀錄
73+
若需刪除紀錄，請參考以下步驟：
74+
1. 於表格內點選所需的刪除的項目
75+
2. 於最下方的Modify區域將會顯示您所點選的項目，點選 Delete按鈕即可刪除
76+
### 清除所選項目
77+
若需清除所選項目，請參考以下步驟：
78+
1. 於最下方的Modify區域將會顯示您目前所點選的項目，並可點選Refresh按鈕，即可取消所選項目
79+
80+
---
81+
## AddExpense頁面指引
82+
![](https://hackmd.io/_uploads/BkLQ1EM8h.png)
83+
84+
85+
* Category的下拉選單可選取所花費的項目
86+
* Date欄位輸入可參考[日期輸入指引](#日期輸入指引)
87+
* Amount欄位可直接輸入金額，僅限輸入<font color="#f00">數字</font>
88+
* Detail欄位可輸入任何關於本次花費的細節、備註事項
89+
* 若需增加收入項目，請參考[AddIncome頁面指引](#AddIncome頁面指引)
90+
91+
---
92+
## AddIncome頁面指引
93+
![](https://hackmd.io/_uploads/BJzFamzLn.png)
94+
* Category的下拉選單可選取所花費的項目
95+
* Date欄位輸入可參考[日期輸入指引](#日期輸入指引)
96+
* Amount欄位可直接輸入金額，僅限輸入<font color="#f00">數字</font>
97+
* Detail欄位可輸入任何關於本次花費的細節、備註事項
98+
* 若需增加收入項目，請參考[AddExpense頁面指引](#AddExpense頁面指引)
99+
100+
101+
---
102+
103+
## 日期輸入指引
104+
![](https://hackmd.io/_uploads/SJsW27fLh.png)
105+
* 以AddExpense頁面為例
106+
* 可點選右方小日曆按鈕，即會跳出日期選項，直接單擊日期即可自動填入日期

‎README.md

+22-19
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
* Use MVC pattern.
55
* Support CRUD operations.
66

7-
## About
8-
An easy-to-use money tracking window application where users can log in, register, record income and expenses, view/search/filter/modify financial records and view financial summaries according to the selected year and month.
9-
107
<p align="center">
118
<img src="figure/login.png" alt=login.png width=100%>
129
</p>
1310

11+
## About
12+
An easy-to-use money tracking window application where users can log in, register, record incomes and expenses, view/search/filter/modify financial records and view financial summaries according to the selected year and month.
13+
14+
15+
1416

1517
## Software And Tools Required
1618
* Java
@@ -26,10 +28,10 @@ An easy-to-use money tracking window application where users can log in, registe
2628
* Database: [MySQL](https://www.mysql.com/downloads/)
2729
2. Open Eclipse EE.
2830
3. Clone this repository
29-
* Click On File > Import > Git > Projects From Git > Next > Clone URI
30-
* Paste `https://github.com/JeepWay/MoneyTracker.git` in URI -> Next
31-
* Select master Branch > Next > Select Destination Directory -> Next
32-
* Select import as general project -> Next -> Finish
31+
* Click On File > Import > Git > Projects From Git(with smart import) > Next
32+
* Clone URI > Next > Paste `https://github.com/JeepWay/MoneyTracker.git` in URI > Next
33+
* Select master Branch > Next > Select Destination Directory > Next
34+
* Ckeckout Import Source > Finish
3335
4. Create MySQL database
3436
* Open MySQL Command Prompt or MySQL Workbench
3537
* Login to the administrator user as : `mysql -u <adminusername> -p`
@@ -40,10 +42,12 @@ An easy-to-use money tracking window application where users can log in, registe
4042
* Open `src/main/resources/application.properties` file
4143
* Modify the value of database details according to your installed MySQL admin user setting. db.name is refer to the database of this project, which is default to `moneytracker`.
4244
6. Build project
43-
* Right Click on Project -> Show In -> Terminal -> Paste `mvn clean install` in terminal
44-
* Check the output of `mvn clean install` and ensure success build.
45+
* Right Click on Project > Maven > Update Project... > Click Force Update > Select moneytracker > OK
46+
* Right Click on Project > Run as > Maven Build > Paste `clean install` in the goals field > apply > run
47+
* Check the output in console and make ensure success build.
4548
7. Run application
46-
* Paste `mvn exec:java` in terminal
49+
* Right Click on Project > Run as > Maven Build > Paste `exec:java` in the goals field > apply > run
50+
* For simplicity, you can just open terminal, then paste `mvn exec:java` command
4751
8. Login
4852
* The default username and password is `demo` and `8888`
4953
* If you want to create the new user, just click signup page to create new user information
@@ -56,7 +60,7 @@ An easy-to-use money tracking window application where users can log in, registe
5660
2. Clone this repository
5761
* Open terminal
5862
* Paste `git clone https://github.com/JeepWay/MoneyTracker.git` in terminal
59-
* `cd moneytracker`
63+
* `cd MoneyTracker`
6064
3. Create MySQL database
6165
* Open MySQL Command Prompt or MySQL Workbench
6266
* Login to the administrator user as : `mysql -u <adminusername> -p`
@@ -107,7 +111,6 @@ An easy-to-use money tracking window application where users can log in, registe
107111
| | ├── PanelCardDashBoardUI.java
108112
| | ├── PanelCardHistoryUI.java
109113
| | ├── SignupPageUI.java
110-
| | ├── SwingCalendarUI.java
111114
├── resources
112115
| ├── icon
113116
| | ├── *.png
@@ -132,24 +135,24 @@ Furthermore, you can also click the question marks in window application which i
132135

133136
If your are familiar with english, we also provide the english version of the tour in [`MoneyTrackerTour.en-US.md`](MoneyTrackerTour.en-US.md)
134137

135-
## Application Sanpshot
138+
## Application Snapshot
136139
<p align="center">
137-
<img src="figure/login.png" alt=login.png width=90%>
140+
<img src="figure/login.png" alt=login.png width=100%>
138141
</p>
139142
<p align="center">
140-
<img src="figure/signup.png" alt=signup.png width=90%>
143+
<img src="figure/signup.png" alt=signup.png width=100%>
141144
</p>
142145
<p align="center">
143-
<img src="figure/dashboard.png" alt=dashboard.png width=90%>
146+
<img src="figure/dashboard.png" alt=dashboard.png width=100%>
144147
</p>
145148
<p align="center">
146-
<img src="figure/history.png" alt=history.png width=90%>
149+
<img src="figure/history.png" alt=history.png width=100%>
147150
</p>
148151
<p align="center">
149-
<img src="figure/addexpense.png" alt=addexpense.png width=90%>
152+
<img src="figure/addexpense.png" alt=addexpense.png width=100%>
150153
</p>
151154
<p align="center">
152-
<img src="figure/addincome.png" alt=addincome.png width=90%>
155+
<img src="figure/addincome.png" alt=addincome.png width=100%>
153156
</p>
154157

155158

0 commit comments

Comments
 (0)