Skip to content

Commit 6c0c400

Browse files
README
1 parent 010645c commit 6c0c400

File tree

1 file changed

+32
-32
lines changed

1 file changed

+32
-32
lines changed

README.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🔔 Subscription Tracker (Dockerized)
1+
# Subscription Tracker (Dockerized)
22
<p align="center">
33
<img src="https://github.com/GitTimeraider/Assets/blob/main/Subscription-Tracker-docker/img/icon_sub.png" />
44
</p>
@@ -14,16 +14,16 @@ Welcome to the most wonderfully comprehensive and dockerized way to track your s
1414
</p>
1515

1616

17-
## Features
17+
## Features
1818

19-
### 🔐 **Multi-User System with Admin Controls**
19+
### **[Security] Multi-User System with Admin Controls**
2020
- Secure multi-user environment with role-based access control
2121
- **Admin Users**: Can manage all users, create new accounts, and access admin settings
2222
- **Standard Users**: Can only manage their own subscriptions and settings
2323
- No public registration - only admins can create new user accounts
2424
- Individual user accounts with personalized settings and isolated data
2525

26-
### 📊 **Comprehensive Subscription Management**
26+
### **[Core] Comprehensive Subscription Management**
2727
- Add, edit, and remove subscriptions with ease
2828
- Support for multiple categories: Software, Hardware, Entertainment, Utilities, Cloud Services, News & Media, Education, Fitness, Gaming, and more
2929
- Detailed subscription information including notes
@@ -33,7 +33,7 @@ Welcome to the most wonderfully comprehensive and dockerized way to track your s
3333
</p>
3434

3535

36-
### 💰 **Flexible Billing Cycles**
36+
### **[Billing] Flexible Billing Cycles**
3737
- **Daily** - Perfect for daily service charges
3838
- **Weekly** - For weekly subscriptions
3939
- **Bi-weekly** - Every 2 weeks
@@ -44,28 +44,28 @@ Welcome to the most wonderfully comprehensive and dockerized way to track your s
4444
- **Yearly** - Annual subscriptions
4545
- **Custom** - Define your own billing period (every 5 years? Why not!)
4646

47-
### 📧 **Smart Email Notifications**
47+
### **[Notifications] Smart Email Notifications**
4848
- Get notified before subscriptions expire
4949
- Customizable notification timing (1-365 days before expiry)
5050
- Rich HTML email format with urgency indicators
5151
- Multiple daily checks to ensure timely notifications
5252
- User-specific notification preferences
5353

54-
### 📈 **Analytics & Insights**
54+
### **[Analytics] Analytics & Insights**
5555
- Cost tracking with monthly and yearly projections
5656
- Category-based spending breakdown
5757
- Interactive charts and visualizations
5858
- Upcoming renewals dashboard
5959
- Billing cycle distribution analysis
6060

61-
### 💹 **Accurate Multi-Currency Conversion**
61+
### **[Currency] Accurate Multi-Currency Conversion**
6262
- Per-user preferred display currency (defaults to EUR)
6363
- High-precision Decimal math (no floating point drift)
6464
- Multi-provider live EUR base exchange rates with automatic fallback
6565
- Cached daily (per provider) with manual refresh & force-refetch
6666
- Transparent attempt chain + active provider/mismatch badges in settings & dashboard
6767

68-
### ⚙️ **Powerful Settings**
68+
### **[Configuration] Powerful Settings**
6969
- **User Settings**: Change username, email, and password
7070
- **Notification Settings**: Configure email preferences, timing, and timezone
7171
- **General Settings**: Preferred currency, theme, accent color, date format, and exchange rate provider
@@ -80,7 +80,7 @@ Welcome to the most wonderfully comprehensive and dockerized way to track your s
8080
</p>
8181

8282

83-
### 🎨 **Beautiful Interface**
83+
### **[UI/UX] Beautiful Interface**
8484
- Modern, responsive design using Bootstrap 5
8585
- Intuitive navigation and user experience
8686
- Mobile-friendly layout with configurable date formatting (DD/MM/YYYY or MM/DD/YYYY)
@@ -92,12 +92,12 @@ Welcome to the most wonderfully comprehensive and dockerized way to track your s
9292
</p>
9393

9494

95-
### 🐳 **Docker Support**
95+
### **[Deployment] Docker Support**
9696
- Easy deployment with Docker
9797
- Pre-built images available on GitHub Container Registry
9898
- Environment variable configuration
9999

100-
## 🐳 Docker Deployment
100+
## Docker Deployment
101101

102102
### Database Options
103103

@@ -158,7 +158,7 @@ services:
158158
4. **Access the application:**
159159
- Navigate to `http://localhost:5000`
160160
- Default admin credentials: `admin` / `changeme`
161-
- **⚠️ Change the default password immediately!**
161+
- **[IMPORTANT] Change the default password immediately!**
162162
- Only admins can create new user accounts
163163

164164
### Building from Source
@@ -284,13 +284,13 @@ MAIL_PASSWORD=your-password
284284
285285
```
286286

287-
## 📱 Usage Guide
287+
## Usage Guide
288288

289289
### First Time Setup
290290

291291
1. **Access the application** at `http://localhost:5000`
292292
2. **Login** with default admin credentials: `admin` / `changeme`
293-
3. **⚠️ Immediately change the default password** in User Settings
293+
3. **[IMPORTANT] Immediately change the default password** in User Settings
294294
4. **Create user accounts** (admin only):
295295
- Go to Settings → Admin Settings → Users
296296
- Click "Add User" to create new accounts
@@ -328,12 +328,12 @@ [email protected]
328328

329329
### Managing Subscriptions
330330

331-
- **👀 View**: All subscriptions displayed on dashboard with filtering and sorting options
332-
- **✏️ Edit**: Click "Edit" to modify subscription details
333-
- **🔄 Toggle**: Activate/deactivate subscriptions without deleting
334-
- **🗑️ Delete**: Remove subscriptions with confirmation
335-
- **🔍 Filter**: By category, status, or expiration timeline
336-
- **📊 Sort**: Click column headers or use dropdown to sort by:
331+
- **View**: All subscriptions displayed on dashboard with filtering and sorting options
332+
- **Edit**: Click "Edit" to modify subscription details
333+
- **Toggle**: Activate/deactivate subscriptions without deleting
334+
- **Delete**: Remove subscriptions with confirmation
335+
- **Filter**: By category, status, or expiration timeline
336+
- **Sort**: Click column headers or use dropdown to sort by:
337337
- **Name** (A-Z or Z-A)
338338
- **Company** (A-Z or Z-A)
339339
- **Category** (A-Z or Z-A)
@@ -380,7 +380,7 @@ Behind the scenes, each subscription’s native currency is normalized via EUR b
380380
- If totals look stale, click Refresh Rates; check attempt chain for failures.
381381
- To test fallback, temporarily set an invalid provider order in `CURRENCY_PROVIDER_PRIORITY` and observe the chain (not recommended in production).
382382

383-
## 👥 Multi-User System
383+
## Multi-User System
384384

385385
### User Roles
386386

@@ -407,7 +407,7 @@ Behind the scenes, each subscription’s native currency is normalized via EUR b
407407
On first startup, if no admin users exist, the system creates:
408408
- **Username:** `admin`
409409
- **Password:** `changeme`
410-
- **⚠️ Change this password immediately after first login!**
410+
- **[IMPORTANT] Change this password immediately after first login!**
411411

412412
### User Management
413413

@@ -417,12 +417,12 @@ Admins can manage users through **Settings → Admin Settings → Users**:
417417
- Edit user details and roles
418418
- Delete users (with safety restrictions)
419419

420-
## 🔒 Security Considerations
420+
## Security Considerations
421421

422-
- **🚨 Change the default admin password immediately** after first login (`admin` / `changeme`)
423-
- **👥 User Access Control**: Only admins can create new user accounts
424-
- **🔐 Data Isolation**: Users can only access their own subscriptions and settings
425-
- **🛡️ Admin Protections**:
422+
- **[CRITICAL] Change the default admin password immediately** after first login (`admin` / `changeme`)
423+
- **[Access Control] User Access Control**: Only admins can create new user accounts
424+
- **[Data Protection] Data Isolation**: Users can only access their own subscriptions and settings
425+
- **[Admin Safety] Admin Protections**:
426426
- Admins cannot delete themselves while logged in
427427
- System prevents deletion of the last admin user
428428
- Cannot remove admin privileges from the last admin
@@ -432,7 +432,7 @@ Admins can manage users through **Settings → Admin Settings → Users**:
432432
- Keep your environment variables secure and never commit them to version control
433433
- Regularly review user accounts and remove unused ones
434434

435-
## 🐛 Troubleshooting
435+
## Troubleshooting
436436

437437
### Email Notifications Not Working
438438
1. **Use the Test Email feature**: Go to Settings → Notification Settings and click "Send Test Email"
@@ -447,7 +447,7 @@ Admins can manage users through **Settings → Admin Settings → Users**:
447447

448448
#### SQLite Issues
449449
1. Stop the application
450-
2. Delete `subscriptions.db` (⚠️ this will delete all data)
450+
2. Delete `subscriptions.db` (**WARNING:** this will delete all data)
451451
3. Restart the application to recreate the database
452452

453453
#### PostgreSQL Connection Issues
@@ -518,9 +518,9 @@ Admins can manage users through **Settings → Admin Settings → Users**:
518518
1. Stop the container
519519
2. Delete the database file: `rm ./data/subscriptions.db`
520520
3. Restart the container (this will recreate the default admin account)
521-
4. **⚠️ Warning: This deletes ALL data including all users and subscriptions**
521+
4. **[WARNING] This deletes ALL data including all users and subscriptions**
522522

523-
## 📄 License
523+
## License
524524

525525
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
526526

0 commit comments

Comments
 (0)