139 lines
4.3 KiB
Markdown
139 lines
4.3 KiB
Markdown
|
|
# Map Viewer Manual
|
|
|
|
This manual provides step-by-step instructions for using the NocoDB Map Viewer web application. Each section covers a major feature with direct instructions. *(Insert screenshot - feature overview)*
|
|
|
|
---
|
|
|
|
## 1. Logging In
|
|
|
|
1. Go to the map site URL (e.g., http://localhost:3000).
|
|
2. Enter your email and password on the login page.
|
|
3. Click **Login**.
|
|
- If you forget your password, contact an admin. *(Insert screenshot - login page)*
|
|
|
|
---
|
|
|
|
## 2. Viewing the Map
|
|
|
|
1. After login, you will see the interactive map.
|
|
2. Use your mouse or touch to pan and zoom.
|
|
3. Your current location may be shown as a blue dot. *(Insert screenshot - main map view)*
|
|
|
|
---
|
|
|
|
## 3. Adding a New Location
|
|
|
|
1. Click the **Add Location** button (usually a plus icon on the map).
|
|
2. Click on the map where you want to add the new location.
|
|
3. Fill out the form:
|
|
- First Name, Last Name, Email, Phone, Unit Number, Support Level, Address, Sign, Sign Size, Notes.
|
|
4. Click **Save**.
|
|
5. The new location will appear as a marker on the map. *(Insert screenshot - add location form)*
|
|
|
|
---
|
|
|
|
## 4. Editing or Deleting a Location
|
|
|
|
1. Click on a location marker.
|
|
2. In the popup, click **Edit** to update details, or **Delete** to remove the location.
|
|
3. Confirm your changes. *(Insert screenshot - location popup with edit/delete)*
|
|
|
|
---
|
|
|
|
## 5. Auto-Refresh
|
|
|
|
The map automatically refreshes every 30 seconds to show the latest data. *(Insert screenshot - refresh indicator)*
|
|
|
|
---
|
|
|
|
## 6. Map Start Location & Boundaries
|
|
|
|
1. The map opens to the default start location (Edmonton, Canada, unless changed by admin).
|
|
2. Admins can set boundaries to restrict where points can be added. *(Insert screenshot - map boundaries)*
|
|
|
|
---
|
|
|
|
## 7. Walk Sheet Generator
|
|
|
|
1. Go to the **Walk Sheet** section (usually in the admin panel).
|
|
2. Enter the title, subtitle, footer, and QR code info.
|
|
3. Click **Generate** to create a printable walk sheet.
|
|
4. Download or print the sheet. *(Insert screenshot - walk sheet generator)*
|
|
|
|
---
|
|
|
|
## 8. QR Code Integration
|
|
|
|
1. QR codes can be added to walk sheets for quick access to digital resources.
|
|
2. Enter the URL and label for each QR code in the settings.
|
|
3. QR codes will appear on the generated walk sheet. *(Insert screenshot - QR code on walk sheet)*
|
|
|
|
---
|
|
|
|
## 9. Volunteer Shift Management
|
|
|
|
### For All Users
|
|
1. Go to **Shifts** (http://localhost:3000/shifts.html).
|
|
2. View shifts in **Grid** or **Calendar** view.
|
|
3. Click a shift to see details.
|
|
4. Click **Sign Up** to join a shift.
|
|
5. Your signed-up shifts are shown at the top. *(Insert screenshot - shifts grid and calendar)*
|
|
|
|
### Cancel a Signup
|
|
1. Click **Cancel** next to a shift you signed up for.
|
|
2. Confirm cancellation. *(Insert screenshot - cancel signup)*
|
|
|
|
### Calendar Color Codes
|
|
- **Green**: Shifts you signed up for
|
|
- **Blue**: Available shifts
|
|
- **Gray**: Full shifts
|
|
|
|
---
|
|
|
|
## 10. Admin Features
|
|
|
|
### Shift Management
|
|
1. Go to **Admin Panel** (http://localhost:3000/admin.html).
|
|
2. Create, edit, or cancel shifts.
|
|
3. View all signups and manage volunteers. *(Insert screenshot - admin shift management)*
|
|
|
|
### User Management
|
|
1. In the admin panel, go to **User Management**.
|
|
2. Add new users with email, password, and role (admin/user).
|
|
3. Delete users as needed. *(Insert screenshot - user management panel)*
|
|
|
|
### Map Start Location
|
|
1. In the admin panel, go to **Start Location**.
|
|
2. Select coordinates and zoom level.
|
|
3. Save changes to update the map default. *(Insert screenshot - start location config)*
|
|
|
|
### Walk Sheet Config
|
|
1. In the admin panel, go to **Walk Sheet Config**.
|
|
2. Edit walk sheet fields and QR codes.
|
|
3. Save to persist changes. *(Insert screenshot - walk sheet config panel)*
|
|
|
|
---
|
|
|
|
## 11. Troubleshooting
|
|
|
|
- **Locations not showing:** Check that location data includes latitude/longitude and your API token has read permissions.
|
|
- **Cannot add locations:** Ensure your API token has write permissions and coordinates are valid.
|
|
- **Connection errors:** Verify NocoDB is accessible and API URL is correct.
|
|
- **Build script issues:** Make sure your NocoDB database is clean and API token has admin permissions.
|
|
|
|
---
|
|
|
|
## 12. Security & Privacy
|
|
|
|
- All API tokens are kept server-side only.
|
|
- CORS and rate limiting are enabled.
|
|
- Input validation and security headers are enforced.
|
|
|
|
---
|
|
|
|
## 13. Support
|
|
|
|
For help, check the troubleshooting section, review NocoDB docs, or contact your admin. *(Insert screenshot - help section)*
|
|
|