Benny-Tang commited on
Commit
491faa6
·
verified ·
1 Parent(s): d2c308e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -44
README.md CHANGED
@@ -9,64 +9,44 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- # 🚦 SwiftCase.ai Traffic Summons & Appeals (Trilingual MVP)
13
 
14
- SwiftCase.ai is a **real-world prototype** for managing **traffic summons** in Malaysia.
15
- It provides a **citizen-facing portal** in **English, Bahasa Melayu, and Chinese** simultaneously,
16
- giving fair appeal opportunities and enabling online payments.
17
 
18
  ---
19
 
20
- ## Features
21
 
22
- ### 👨‍👩‍👧 Citizen Portal (3 Languages)
23
- - **Create Case**: Enter summons details (Name, Address, Ticket Number, Vehicle, Location, State).
24
- - **View Case**: See all details in **English, BM, Chinese**.
25
- - **Submit Appeal**: Citizens can appeal to **PDRM** (compound fines) or **Magistrate**.
26
- - **AI Recommendation**: Shows suggested outcome (reduce/reject/waive).
27
- - **Pay Fine**: Pay securely online and receive **e-receipt in 3 languages**.
 
 
 
28
 
29
- ### 🚔 PDRM (Compound Fine Appeals)
30
- - Citizens submit appeals.
31
- - **AI suggests a decision** (e.g. reduce if >RM200, reject if smaller fine).
32
- - **PDRM officer confirms/overrides** in their system.
33
- - Reply sent back to SwiftCase.ai → shown to citizen in 3 languages.
34
 
35
- ### ⚖️ Magistrate (Judicial Appeals)
36
- - Appeals go to magistrates.
37
- - **AI prepares summary + recommendation**.
38
- - **Judge confirms final decision**.
39
- - Decision returned to SwiftCase.ai → shown to citizen in 3 languages.
40
 
41
  ---
42
 
43
- ## 📊 Database Schema
44
 
45
- SQLite database: `cases.db`
46
-
47
- - **summons_cases** citizen-entered summons.
48
- - **appeals** – appeal records.
49
- - **reviews** – PDRM & Magistrate review outcomes.
50
- - **payments** – payments made.
51
- - **receipts** – e-receipts issued.
52
 
53
  ---
54
 
55
- ## 🧪 Citizen Workflow
56
-
57
- 1. Citizen keys in details from **PDRM summon ticket**:
58
- - Name / Address
59
- - Summon Ticket Number
60
- - Vehicle Number
61
- - Road, Town/City, State
62
- - Offence (entered in EN, BM, CN)
63
- - Fine amount (default RM300)
64
-
65
- 2. Citizen can then:
66
- - **View Case** (always trilingual).
67
- - **Submit Appeal** to PDRM or Magistrate.
68
- - **Pay Fine** online.
69
 
70
- 3. **Replies** (from AI recommendation + human confirmation) are shown in the same **trilingual format**.
71
 
72
  ---
 
9
  pinned: false
10
  ---
11
 
12
+ # 🚦 SwiftCase.ai Traffic Summons Appeal & Payment Platform
13
 
14
+ SwiftCase.ai is a prototype platform to **digitize traffic summons appeal and payment in Malaysia**.
15
+ It allows **citizens**, **PDRM officers**, and **magistrates** to interact with cases online.
 
16
 
17
  ---
18
 
19
+ ## 🌟 Features
20
 
21
+ ### Citizen Portal
22
+ - **Create Case**: Enter details of your summon ticket (Ticket No., Name, Vehicle No., Address, Location, Offence).
23
+ - **View Case**: Search case by:
24
+ - Ticket Number (No. Saman)
25
+ - OR Name (Nama)
26
+ - OR Vehicle Number (No. Kenderaan)
27
+ - **Submit Appeal**: Send appeal text to **PDRM** or **Magistrate**.
28
+ - **Pay Fine**: Pay fine online and receive a digital receipt.
29
+ - **Trilingual Support**: English, Bahasa Melayu, 中文 — for all citizen interactions.
30
 
31
+ ### PDRM Portal (Internal)
32
+ - Officers can confirm or reject AI recommendations on compound fine appeals.
33
+ - Standard fine is RM300; officer may approve reduction or reject.
 
 
34
 
35
+ ### Magistrate Portal (Internal)
36
+ - Magistrate can approve, reduce, or cancel fines.
37
+ - AI provides a suggestion, but **human confirmation is always required**.
 
 
38
 
39
  ---
40
 
41
+ ## ⚙️ Tech
42
 
43
+ - **Python 3.10+**
44
+ - **Gradio 5.44.1**
45
+ - **SQLite3** (cases.db automatically created & seeded with mock data)
 
 
 
 
46
 
47
  ---
48
 
49
+ ## 📦 Project Structure
 
 
 
 
 
 
 
 
 
 
 
 
 
50
 
 
51
 
52
  ---