Skip to content

Commit a61a86a

Browse files
committed
docs: Revamp project README and update DaisyUI dependency.
1 parent 6b2ca14 commit a61a86a

File tree

3 files changed

+188
-35
lines changed

3 files changed

+188
-35
lines changed

README.md

Lines changed: 184 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,216 @@
1-
# InvestCount – Maximize Your Savings and Financial Growth
1+
# InvestCount – Indonesia's Independent Deposit Calculator
22

3-
![screencapture-localhost-5173-2024-09-12-12_55_14](https://github.com/user-attachments/assets/1e5077fb-da81-4e49-84cc-e8bc40a5639d)
3+
<div align="center">
44

5-
## Description
5+
![InvestCount Banner](https://github.com/user-attachments/assets/1e5077fb-da81-4e49-84cc-e8bc40a5639d)
66

7-
**InvestCount** is your go-to tool for boosting your savings and growing your wealth, effortlessly! Just enter your deposit amount, interest rate, tax rate, and holding period (in months) – and voilà, you get your interest calculated instantly. 🎯💰
7+
**Hitung bunga deposito bersih dalam 5 detik. Gratis & tanpa iklan.**
88

9-
Start making smart financial decisions with real-time insights, and watch your savings grow! 🚀
9+
[![Version](https://img.shields.io/badge/version-1.5.0-blue.svg)](https://github.com/HellBus1/InvestCount)
10+
[![License](https://img.shields.io/badge/license-Apache%202.0-green.svg)](LICENSE)
11+
[![Live Demo](https://img.shields.io/badge/demo-live-success.svg)](https://investtcount.mattrmost.com/)
1012

11-
## Features
13+
</div>
1214

13-
1. **Responsive Design:** Enjoy a seamless experience on any device, whether you're on mobile, tablet, or desktop. 📱💻
15+
---
1416

15-
2. **Real-time Deposit Calculation:** Effortlessly calculate interest rates, tax deductions, and holding periods with live results as you type. 💻🔢
17+
## 📖 About
1618

17-
3. **Modern User Interface:** A sleek, intuitive design that makes complex calculations feel simple and engaging. 🎨✨
19+
**InvestCount** is Indonesia's most transparent and independent deposit calculator platform. We help Indonesians—from young savers to retirees—understand how their money works through deposits with honesty and simplicity.
1820

19-
4. **Easy-to-Use:** Start calculating in seconds—no need to be a financial expert! 😉
21+
Unlike other financial tools, InvestCount is:
22+
- 🔍 **Transparent** – No hidden agendas or bank affiliations
23+
- 📚 **Educational** – Learn while you calculate
24+
- 🆓 **Free Forever** – No subscriptions or paywalls
25+
- 🚫 **Ad-Free** – Clean, distraction-free experience
26+
- 🔒 **Privacy-First** – No login required, no data collection
2027

21-
5. **Deposit Growth Predictions (Coming Soon):** Visualize your long-term savings growth with a customizable forecast table for up to 5 or 10 years. 📊📈
28+
> **Mission**: *"Membantu setiap orang Indonesia memahami bagaimana uang mereka bekerja melalui deposito, dengan jujur dan sederhana."*
2229
23-
## What's New in Version 1.1.1
24-
Deposit graphs that display all deposit rates for banks in Indonesia (especially digital banks), helping users decide where to invest their deposits.
30+
---
2531

26-
![screencapture-investcount-pages-dev-2025-03-23-06_07_56 (2)](https://github.com/user-attachments/assets/428ee904-c1e9-4369-a8b9-0fa69e78a697)
32+
## ✨ Features
2733

34+
### 🧮 Core Calculator
35+
- **Real-time Deposit Calculation** – Calculate interest, tax deductions (20%), and net returns instantly
36+
- **ARO Support** – Simulate Automatic Roll Over (ARO) and ARO+ with compounding effects
37+
- **Multiple Deposit Types** – Support for Non-ARO, ARO, and ARO+ calculations
38+
- **Tax Calculation** – Automatic 20% tax deduction as per Indonesian regulations
39+
- **Flexible Tenors** – Calculate for 1, 3, 6, or 12-month periods
2840

29-
## Getting Started
41+
### 📊 Bank Comparison
42+
- **Comprehensive Rate Comparison** – Compare deposit rates from major Indonesian banks
43+
- **Digital & Traditional Banks** – Coverage of both conventional and digital banks
44+
- **Visual Charts** – Interactive charts powered by Recharts for easy comparison
45+
- **Up-to-date Information** – Regular updates with last-updated timestamps
3046

31-
1. **Clone the repository** :
32-
```shell
47+
### 💰 Budget Planner
48+
- **Financial Planning Tool** – Plan your deposit strategy with our budget planner
49+
- **Goal Setting** – Set financial goals and track progress
50+
- **Smart Recommendations** – Get personalized deposit recommendations
51+
52+
### 🛡️ LPS Information
53+
- **Deposit Insurance** – Learn about LPS (Lembaga Penjamin Simpanan) coverage
54+
- **Safety Guidelines** – Understand deposit safety limits (up to Rp 2 billion per bank)
55+
- **Educational Content** – Clear explanations of deposit protection
56+
57+
### 📝 Financial Education Blog
58+
- **Expert Articles** – Learn about deposits, taxes, and financial planning
59+
- **SEO-Optimized Content** – Easy-to-find answers to common questions
60+
- **Current Topics**:
61+
- Cara Menghitung Bunga Deposito
62+
- Deposito vs Tabungan
63+
- Inflasi dan Deposito
64+
65+
### 🎨 User Experience
66+
- **Responsive Design** – Seamless experience on mobile, tablet, and desktop
67+
- **Modern UI/UX** – Clean, intuitive interface with smooth animations
68+
- **Accessibility** – WCAG 2.1 AA compliant
69+
- **Dark Mode Ready** – Comfortable viewing in any lighting condition
70+
- **Quick Navigation** – Floating action button for easy site navigation
71+
72+
---
73+
74+
## 🛠️ Technology Stack
75+
76+
### Frontend Framework
77+
- **React 18.3.1** – Modern React with hooks and concurrent features
78+
- **TypeScript 5.2.2** – Type-safe development
79+
- **Vite 6.2.2** – Lightning-fast build tool and dev server
80+
81+
### Styling & UI
82+
- **Tailwind CSS 3.4.7** – Utility-first CSS framework
83+
- **DaisyUI 5.5.5** – Beautiful component library
84+
- **Motion 12.6.2** – Smooth animations and transitions
85+
86+
### Content & Documentation
87+
- **MDX 3.1.1** – Write JSX in Markdown for rich blog content
88+
- **Remark GFM 4.0.1** – GitHub Flavored Markdown support
89+
- **Rehype Plugins** – Auto-linking headings and slug generation
90+
- **Gray Matter 4.0.3** – Front matter parsing for blog posts
91+
- **Reading Time 1.5.0** – Estimated reading time for articles
92+
93+
### Data Visualization
94+
- **Recharts 2.15.1** – Composable charting library for React
95+
96+
### Routing
97+
- **React Router DOM 6.26.2** – Declarative routing for React
98+
99+
### Development Tools
100+
- **ESLint** – Code linting and quality checks
101+
- **Prettier 3.3.3** – Code formatting
102+
- **Husky 8.0.0** – Git hooks for pre-commit checks
103+
- **Lint-Staged 15.2.9** – Run linters on staged files
104+
- **Jest 29.7.0** – Testing framework
105+
106+
---
107+
108+
## 🚀 Getting Started
109+
110+
### Prerequisites
111+
- Node.js 16+ and npm/yarn installed
112+
- Git for version control
113+
114+
### Installation
115+
116+
1. **Clone the repository**
117+
```bash
33118
git clone git@github.com:HellBus1/InvestCount.git
34119
cd InvestCount
35120
```
36121

37-
2. **Install dependencies** :
38-
```shell
122+
2. **Install dependencies**
123+
```bash
39124
npm install
40125
```
41126

42-
3. **Run the development server** :
43-
```shell
127+
3. **Run the development server**
128+
```bash
44129
npm run dev
45130
```
46131

47-
4. **Build for production** :
48-
```shell
132+
The app will be available at `http://localhost:5173`
133+
134+
4. **Build for production**
135+
```bash
49136
npm run build
50137
```
51138

52-
## Getting Started
139+
5. **Preview production build**
140+
```bash
141+
npm run preview
142+
```
143+
144+
### Available Scripts
145+
146+
| Script | Description |
147+
|--------|-------------|
148+
| `npm run dev` | Start development server |
149+
| `npm run build` | Build for production |
150+
| `npm run preview` | Preview production build |
151+
| `npm run lint` | Run ESLint |
152+
| `npm run lint:fix` | Fix ESLint errors |
153+
| `npm run format` | Format code with Prettier |
154+
| `npm test` | Run Jest tests |
155+
156+
---
157+
158+
## 🤝 Contributing
159+
160+
Contributions are welcome! Here's how you can help:
161+
162+
1. Fork the repository
163+
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
164+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
165+
4. Push to the branch (`git push origin feature/amazing-feature`)
166+
5. Open a Pull Request
167+
168+
Please ensure your code:
169+
- Follows the existing code style
170+
- Passes all linting checks (`npm run lint`)
171+
- Is properly formatted (`npm run format`)
172+
- Includes appropriate tests
173+
174+
---
175+
176+
## 📄 License
177+
178+
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
179+
180+
---
181+
182+
## 👨‍💻 Author
183+
184+
**Syubban Fakhriya**
185+
186+
- GitHub: [@HellBus1](https://github.com/HellBus1)
187+
- LinkedIn: [syubban-fakhriya](https://www.linkedin.com/in/syubban-fakhriya/)
188+
189+
---
190+
191+
## 💖 Support
192+
193+
If you find InvestCount helpful, consider supporting the project:
194+
195+
[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/syubban)
196+
197+
Your support helps keep InvestCount free, ad-free, and continuously improving!
198+
199+
---
200+
201+
## 🙏 Acknowledgments
202+
203+
- **React JS Template**: [ts-react-tailwind-starter](https://github.com/HellBus1/ts-react-tailwind-starter)
204+
- **AI Tools**: ChatGPT and other generative AI tools for development assistance
205+
- **Data Sources**: Bank Indonesia, OJK (Otoritas Jasa Keuangan), LPS (Lembaga Penjamin Simpanan)
206+
- **Community**: All contributors and users who provide feedback
207+
208+
---
53209

54-
Contributions are welcome! Please open an issue or submit a pull request.
210+
<div align="center">
55211

56-
## Powered By 🛠️
57-
1. React JS Template: [ts-react-tailwind-starter](https://github.com/HellBus1/ts-react-tailwind-starter)
58-
2. ChatGPT and Other Generative AI Tools 🤖✨
212+
**Made with ❤️ for Indonesia's financial literacy**
59213

60-
## Supports Me
61-
Want to see more free, high-quality code and articles? Buy me a coffee and make it happen!
214+
[Live Demo](https://investtcount.mattrmost.com/)[Report Bug](https://github.com/HellBus1/InvestCount/issues)[Request Feature](https://github.com/HellBus1/InvestCount/issues)
62215

63-
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/syubban)
216+
</div>

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
"@typescript-eslint/parser": "^7.15.0",
4848
"@vitejs/plugin-react-swc": "^3.8.1",
4949
"autoprefixer": "^10.4.19",
50-
"daisyui": "^5.5.5",
50+
"daisyui": "^4.1.12",
5151
"eslint": "^8.57.0",
5252
"eslint-plugin-react-hooks": "^4.6.2",
5353
"eslint-plugin-react-refresh": "^0.4.7",

0 commit comments

Comments
 (0)