RBAC and Doc updates
This commit is contained in:
@@ -38,23 +38,29 @@ web/
|
||||
|
||||
## Usage
|
||||
|
||||
### Development
|
||||
1. Ensure the API is running on port 8000
|
||||
2. Open `index.html` in a web browser
|
||||
3. Enter your API token to authenticate
|
||||
4. Start managing your mailing lists!
|
||||
|
||||
### Production (Docker)
|
||||
The web frontend is served using Nginx and included in the Docker Compose setup.
|
||||
### Accessing the Interface
|
||||
|
||||
**Via Docker (Recommended):**
|
||||
```bash
|
||||
# Build and start all services
|
||||
docker-compose up --build
|
||||
# Ensure all services are running
|
||||
sudo docker-compose up -d
|
||||
|
||||
# Access the web interface
|
||||
open http://localhost:3000
|
||||
```
|
||||
|
||||
**For Development:**
|
||||
You can also open `index.html` directly in a browser, but the API must be running on port 8000.
|
||||
|
||||
### Getting Started
|
||||
|
||||
1. **Authenticate**: Enter your API_TOKEN (from `.env` file) when prompted
|
||||
2. **Manage Lists**: Click the "Lists" tab to view and manage mailing lists
|
||||
3. **Manage Members**: Click the "Members" tab to add and edit member information
|
||||
4. **Manage Subscriptions**: Click "Subscriptions" button on any member to toggle their list memberships
|
||||
|
||||
The interface saves your token in browser storage, so you won't need to re-enter it on subsequent visits.
|
||||
|
||||
## Features Overview
|
||||
|
||||
### Authentication
|
||||
@@ -65,24 +71,39 @@ open http://localhost:3000
|
||||
### Subscription Management (New & Improved!)
|
||||
|
||||
#### Member-Centric Subscription Management
|
||||
The subscription management has been completely overhauled for a much better user experience:
|
||||
The subscription management has been completely redesigned for the best user experience:
|
||||
|
||||
1. **Access Member Subscriptions**: In the Members tab, click the "Subscriptions" button next to any member
|
||||
2. **Visual Toggle Interface**: See all available mailing lists with modern toggle switches
|
||||
3. **Intuitive Controls**:
|
||||
- Green toggle = Member is subscribed
|
||||
- Gray toggle = Member is not subscribed
|
||||
- Click anywhere on a list item to toggle subscription
|
||||
4. **Batch Operations**: Make multiple changes and save them all at once
|
||||
5. **Real-time Feedback**: The save button shows how many changes you've made
|
||||
**How to Use:**
|
||||
1. Navigate to the **Members** tab
|
||||
2. Find the member you want to manage
|
||||
3. Click the **"Subscriptions"** button next to their name
|
||||
4. A modal appears showing all available mailing lists with toggle switches
|
||||
|
||||
#### Benefits Over Previous System
|
||||
- ✅ **Much faster** - No need to add subscriptions one by one
|
||||
**Visual Interface:**
|
||||
- **Green toggle** = Member is subscribed to this list
|
||||
- **Gray toggle** = Member is not subscribed to this list
|
||||
- **Click anywhere** on a list item to toggle subscription on/off
|
||||
|
||||
**Batch Operations:**
|
||||
- Make multiple changes (subscribe to some lists, unsubscribe from others)
|
||||
- The "Save Changes" button shows how many changes you've made (e.g., "Save 3 Changes")
|
||||
- All changes are saved together when you click "Save Changes"
|
||||
- Click "Cancel" to discard all changes
|
||||
|
||||
**Benefits:**
|
||||
- ✅ **Fast** - Toggle multiple subscriptions at once
|
||||
- ✅ **Visual** - See all subscriptions at a glance with color coding
|
||||
- ✅ **Intuitive** - Toggle switches work like modern mobile apps
|
||||
- ✅ **Batch operations** - Change multiple subscriptions simultaneously
|
||||
- ✅ **Less error-prone** - Clear visual feedback prevents mistakes
|
||||
- ✅ **Change tracking** - Only saves actual changes, not unchanged items
|
||||
- ✅ **Intuitive** - Works like modern mobile app switches
|
||||
- ✅ **Smart** - Only saves actual changes, not unchanged items
|
||||
- ✅ **Clear** - Shows exactly how many changes you're about to save
|
||||
|
||||
#### Alternative: Legacy Bulk Subscription
|
||||
For power users who prefer the old approach:
|
||||
1. Go to the **Subscriptions** tab
|
||||
2. Select list and member from dropdowns
|
||||
3. Click "Add Subscription"
|
||||
|
||||
This is still available but the member-centric approach is much more efficient for managing multiple subscriptions.
|
||||
|
||||
### Mailing Lists
|
||||
- View all mailing lists in a clean table
|
||||
|
||||
Reference in New Issue
Block a user