feat: init dataset and web app

.editorconfig

@@ -0,0 +1,10 @@
+# editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true

.env.example

@@ -0,0 +1,37 @@
+# -----------------------------------------------------------------------------
+# App
+# -----------------------------------------------------------------------------
+NEXT_PUBLIC_APP_URL=http://localhost:3000
+SKIP_ENV_VALIDATION=false # Set to true to disable env validation
+
+#-----------------------------------------------------------------------------------------------
+# NextAuth
+#-----------------------------------------------------------------------------------------------
+# You can generate a new secret on the command line with:
+# openssl rand -base64 32
+#-----------------------------------------------------------------------------------------------
+AUTH_URL=http://localhost:3000
+AUTH_SECRET=
+
+#-----------------------------------------------------------------------------------------------
+# Google Credentials
+#-----------------------------------------------------------------------------------------------
+AUTH_GOOGLE_ID=
+AUTH_GOOGLE_SECRET=
+
+#-----------------------------------------------------------------------------------------------
+# Github Credentials
+#-----------------------------------------------------------------------------------------------
+AUTH_GITHUB_ID=
+AUTH_GITHUB_SECRET=
+
+#-----------------------------------------------------------------------------------------------
+# Discord Credentials
+#-----------------------------------------------------------------------------------------------
+AUTH_DISCORD_ID=
+AUTH_DISCORD_SECRET=
+
+#-----------------------------------------------------------------------------------------------
+# Database
+#-----------------------------------------------------------------------------------------------
+DATABASE_URL=

.eslintrc.cjs

@@ -0,0 +1,55 @@
+/** @type {import("eslint").Linter.Config} */
+const config = {
+  extends: [
+    "eslint:recommended",
+    "next/core-web-vitals",
+    "prettier",
+    "plugin:tailwindcss/recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-type-checked",
+    "plugin:@typescript-eslint/stylistic-type-checked",
+  ],
+  plugins: [
+    "eslint-plugin-react-compiler",
+    "tailwindcss",
+    "@typescript-eslint",
+  ],
+  rules: {
+    "@typescript-eslint/prefer-nullish-coalescing": "off",
+    "@typescript-eslint/no-floating-promises": "off",
+    "tailwindcss/no-custom-classname": "off",
+    "tailwindcss/classnames-order": "warn",
+    "@next/next/no-html-link-for-pages": "off",
+    "@typescript-eslint/array-type": "off",
+    "@typescript-eslint/consistent-type-definitions": "off",
+    "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
+    "@typescript-eslint/consistent-type-imports": [
+      "warn",
+      { prefer: "type-imports" },
+    ],
+    "@typescript-eslint/require-await": "off",
+    "@typescript-eslint/no-misused-promises": [
+      "error",
+      {
+        checksVoidReturn: {
+          attributes: false,
+        },
+      },
+    ],
+  },
+  settings: {
+    tailwindcss: {
+      callees: ["cn", "cva"],
+      config: "tailwind.config.ts",
+    },
+    next: {
+      rootDir: ["./"],
+    },
+  },
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: true,
+  },
+};
+
+module.exports = config;

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    name: Run Type Check, Linters & Tests
+    runs-on: ubuntu-latest
+
+    env:
+      SKIP_ENV_VALIDATION: true
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun i
+
+      - name: Check types
+        run: bun run type-check
+
+      - name: Check linting
+        run: bun run lint
+
+      - name: Run tests
+        run: bun test
+
+      - name: Check commits messages
+        uses: wagoid/commitlint-github-action@v6

.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

.husky/commit-msg

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+bunx --no -- commitlint --edit ${1}

.husky/pre-commit

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+bunx lint-staged

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 galin-chung-nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,77 @@
+# Tra cứu sao kê (Account Statement Inquiry)
+
+Link: [tra-cuu-sao-ke.vercel.app](https://tra-cuu-sao-ke.vercel.app/)
+
+## Mục tiêu của dự án (Project Purpose)
+
+Ứng dụng này là một ứng dụng serverless Next.js nhằm cung cấp một nền tảng minh bạch và toàn diện nhất để tra cứu các bản sao kê quyên góp từ thiện của các đơn vị tổ chức tại Việt Nam. Điều này xuất phát từ thực tế trong quá khứ, như đợt lũ lụt ở miền Trung năm 2020 và dịch Covid-19, nhiều quỹ và cá nhân thực hiện kêu gọi quyên góp đã xảy ra tình trạng thiếu minh bạch, lạm dụng, lừa đảo, và chiếm đoạt tài sản, gây thất thoát và gây khó khăn cho việc kiểm soát tiến trình từ thiện. Tất cả là vì thông tin không được công khai và giám sát một cách minh bạch.
+
+---
+
+This is a serverless Next.js app designed to provide the most transparent and comprehensive platform for checking donation statements from charitable organizations in Vietnam. This arises from past situations, such as the Central Vietnam floods in 2020 and the Covid-19 pandemic, where many funds and individuals calling for donations encountered issues of a lack of transparency, abuse, fraud, and embezzlement, leading to losses and making it difficult to monitor charitable processes. All of this happened because information was not made public and transparently monitored.
+
+## Động lực phát triển (Motivation)
+
+Gần đây, bão Yagi cùng với các hiện tượng thiên tai như lũ lụt, lũ quét và sạt lở đất vào tháng 9 năm 2024 đã gây ra thiệt hại nặng nề cho miền Bắc Việt Nam. Hàng trăm người đã mất mạng, cơ sở hạ tầng bị phá hủy nghiêm trọng, và việc tái thiết lại cơ sở hạ tầng cùng cuộc sống của người dân cần sự chung tay của cả quốc gia. Quá trình quyên góp từ thiện là điều không thể thiếu.
+
+Vào ngày 12 tháng 9 năm 2024, Mặt trận Tổ quốc Việt Nam (MTTQVN) đã công bố bản sao kê chi tiết cho các khoản quyên góp vào tài khoản "MTTQVN-Ban Cứu Trợ TW" số 0011001932418 tại ngân hàng VCB vào ngày 11/09/2024, với tổng số tiền quyên góp từ ngày 01/09/2024 đến ngày 10/09/2024 đạt 135 tỷ VNĐ. Tính đến ngày 13/09/2024, tổng số tiền quyên góp vào MTTQ VN đã vượt qua 500 tỷ VNĐ. Những khoản quyên góp lớn như vậy càng nhấn mạnh tầm quan trọng của việc minh bạch trong quản lý thu chi để ngăn chặn gian lận và tham nhũng.
+
+![](./public/mttq0011001932418VCB/summary.png)
+
+Đây không chỉ là một yêu cầu hiện tại mà còn là xu hướng tất yếu trong tương lai. Với sự gia tăng của các sự kiện thiên tai và các cuộc khủng hoảng xã hội, việc minh bạch trong quyên góp sẽ ngày càng trở nên quan trọng hơn. Chúng ta sẽ cần nhiều hơn nữa các bản sao kê chi tiết và cơ chế giám sát để đảm bảo rằng các nguồn lực được sử dụng một cách hiệu quả và chính xác. Đó chính là lý do mà dự án này ra đời và là động lực chính để thúc đẩy sự minh bạch trong hoạt động từ thiện tại Việt Nam.
+
+---
+
+Recently, Typhoon Yagi, along with natural disasters such as floods, flash floods, and landslides in September 2024, has caused severe damage to Northern Vietnam. Hundreds of people have lost their lives, infrastructure has been critically destroyed, and the reconstruction of infrastructure and people’s lives requires nationwide effort. The process of charitable donations is essential.
+
+On September 12, 2024, the Vietnam Fatherland Front released (MTTQVN) a detailed statement for donations to the account `MTTQVN-Ban Cuu Tro TW` number `0011001932418` at VCB bank as of September 11, 2024, with a total donation amount of 135 billion VND from September 1, 2024, to September 10, 2024. As of September 13, 2024, the total donations to MTTQVN have exceeded 500 billion VND. Such large donations highlight the importance of transparency in managing financial transactions to prevent fraud and corruption.
+
+![](./public/mttq0011001932418VCB/summary.png)
+
+This is not only a current necessity but also an inevitable trend for the future. With the increasing frequency of natural disasters and social crises, transparency in donations will become even more crucial. We will need more detailed statements and monitoring mechanisms to ensure that resources are used effectively and accurately. This is the reason for the inception of this project and the primary motivation for promoting transparency in charitable activities in Vietnam.
+
+## Đóng góp của dự án (Project Contributions)
+
+- Thứ nhất, tôi đã chuyển đổi bản sao kê pdf dài 12,000 trang thành 25 file csv (mỗi file khoảng 1MB) lưu trữ chi tiết thông tin về các giao dịch, mỗi giao dịch bao gồm: Ngày giao dịch (TNXDate), Số chứng từ (DocNo), Chi (Debit), Thu (Credit), Số dư (Balance - giao dịch cuối cùng của mỗi ngày sẽ có tổng kết số dư), Mô tả (Transactions in Detail). Hiện tại các dự án tra cứu dữ liệu sao kê chưa tách biệt được khoản thu/chi và số dư, do đó bộ dữ liệu này sẽ giúp mọi người có thông tin để xây dựng hệ thống tra cứu tốt hơn.
+- Thứ hai, tôi cũng đã xây dựng một website tra cứu trên tập dữ liệu sao kê này bằng NextJS, ứng dụng có tốc độ tra cứu khá nhanh, đáp ứng đủ nhu cầu sử dụng của mọi người mà không lo về nguy cơ bị tắc nghẽn.
+
+- First, I have converted a 12,000-page PDF statement into 25 CSV files (each about 1MB) that store detailed information about transactions. Each transaction includes: Transaction Date (TNXDate), Document Number (DocNo), Debit, Credit, Balance (the final balance of each day’s transactions), and Description (Transactions in Detail). Currently, existing data inquiry projects have not separated income/expenses and balance, so this dataset will help people build better query systems.
+- Second, I have also developed a NextJS website for querying this statement dataset. The application provides relatively fast query speeds, meeting users' needs without worrying about potential congestion.
+
+## Kế hoạch sắp tới (Upcoming Plans)
+
+- Số hoá các bản sao kê, VD các bản sao kê trên giấy của các nghệ sĩ
+- Thiết kế và nâng cấp hệ thống để phục vụ chịu tải tốt hơn và nhiều dữ liệu hơn
+- Tối ưu trải nghiệm người dùng
+
+---
+
+- Digitize more statements, e.g., paper statements from artists
+- Design and upgrade the system to handle better load and more data
+- Optimize user experience
+
+## Tham gia đóng góp (How to Contribute)
+
+Chúng tôi rất hoan nghênh mọi người đóng góp vào dự án. Bạn có thể tham gia bằng cách:
+
+- Xây dựng và phát triển dataset sao kê từ thiện.
+- Đóng góp mã nguồn bằng cách tạo Pull request trên GitHub.
+- Đề xuất tính năng mới hoặc báo lỗi.
+
+We welcome contributions from everyone. You can participate by:
+
+- Building and enhancing the charity statement dataset.
+- Contributing to the codebase by submitting Pull requests on GitHub.
+- Proposing new features or reporting bugs.
+
+## Cài đặt (Installation)
+
+1. Fork repo
+2. Use `bun` to install dependencies
+3. Create pull request and wait for approval
+
+## Liên hệ (Contact)
+
+Nếu bạn có bất kỳ câu hỏi hoặc đề xuất nào, vui lòng liên hệ với chúng tôi Linkedin: [Chung Nguyen](https://www.linkedin.com/in/galin-chung-nguyen)
+
+If you have any questions or suggestions, feel free to contact us via Linkedin: [Chung Nguyen](https://www.linkedin.com/in/galin-chung-nguyen)