native-update 1.3.5 → 1.3.7

package/Readme.md

@@ -20,6 +20,13 @@
 - **[Installation Guide](./docs/getting-started/installation.md)** - Step-by-step installation instructions
 - **[Quick Start Guide](./docs/getting-started/quick-start.md)** - Get up and running in minutes
 - **[Configuration Guide](./docs/getting-started/configuration.md)** - Detailed configuration options
+- **[End-to-End Workflow](./docs/guides/end-to-end-workflow.md)** - Complete setup to production guide
+
+### Dashboard & Management
+
+- **[Dashboard Guide](./docs/guides/dashboard-guide.md)** - Complete dashboard user guide
+- **[Channel Management](./docs/guides/channel-management.md)** - Dev/staging/production channels
+- **[Admin Panel](./docs/guides/admin-panel.md)** - Super-admin documentation
 
 ### Features Documentation
 
@@ -31,9 +38,11 @@
 ### Guides & Best Practices
 
 - **[Security Best Practices](./docs/guides/security-best-practices.md)** - Implement secure updates
+- **[Deployment Guide](./docs/guides/deployment-guide.md)** - Deployment procedures
 - **[Migration Guide](./docs/MIGRATION.md)** - Migrate from other solutions
 - **[Production Readiness](./docs/production-readiness.md)** - Production deployment checklist
 - **[Bundle Signing](./docs/BUNDLE_SIGNING.md)** - Cryptographic signing guide
+- **[Troubleshooting](./docs/guides/troubleshooting.md)** - Common issues and solutions
 
 ### API Reference
 
@@ -52,6 +61,36 @@
 
 A **foundation package** for building a comprehensive update management plugin for Capacitor that combines Live/OTA updates, native app store updates, and in-app review capabilities. This package provides the architecture, interfaces, and documentation but requires additional implementation work.
 
+## 🌐 Dashboard & Management Platform
+
+The Native Update platform includes a complete web dashboard for managing your updates:
+
+**Dashboard URL**: [nativeupdate.aoneahsan.com](https://nativeupdate.aoneahsan.com)
+
+### Dashboard Features
+
+- **App Management**: Register and configure multiple apps
+- **Build Uploads**: Upload and manage build versions
+- **Channel Management**: Configure production/staging/development channels
+- **Rollouts**: Gradual rollout with percentage control
+- **Analytics**: Track downloads, installs, errors, and rollbacks
+- **Google Drive Integration**: Secure build storage
+- **Configuration Generator**: Get ready-to-use integration code
+
+### Update Channels
+
+Native Update supports three deployment channels:
+
+| Channel | Purpose | Auto-Update | Check Interval |
+|---------|---------|-------------|----------------|
+| **Development** | Internal testing | Yes | 1 minute |
+| **Staging** | QA/Beta testing | Configurable | 1 hour |
+| **Production** | Live users | No (consent) | Daily |
+
+See [Channel Management Guide](./docs/guides/channel-management.md) for detailed configuration.
+
+---
+
 ## Features
 
 ### 🚀 Live Updates (OTA)
@@ -85,7 +124,7 @@ Increase user engagement with intelligent review prompts:
 ## Installation
 
 ```bash
-npm install native-update
+yarn add native-update
 npx cap sync
 ```
 

package/docs/APP_REVIEW_GUIDE.md

@@ -76,7 +76,7 @@ The App Review feature allows users to rate and review your app without leaving
 ### Installation
 
 ```bash
-npm install native-update
+yarn add native-update
 npx cap sync
 ```
 

package/docs/LIVE_UPDATES_GUIDE.md

@@ -69,7 +69,7 @@ sequenceDiagram
 ### 1. Install the Plugin
 
 ```bash
-npm install native-update
+yarn add native-update
 npx cap sync
 ```
 
@@ -329,7 +329,7 @@ export class UpdateStrategies {
 
 ```bash
 cd server-example
-npm install
+yarn install
 npm start
 ```
 
@@ -389,7 +389,7 @@ Response:
 
 ```bash
 # 1. Build your web app
-npm run build
+yarn build
 
 # 2. Create bundle
 cd dist

package/docs/NATIVE_UPDATES_GUIDE.md

@@ -61,7 +61,7 @@ Native App Updates allow your app to:
 ### Installation
 
 ```bash
-npm install native-update
+yarn add native-update
 npx cap sync
 ```
 

package/docs/README.md

@@ -1,14 +1,15 @@
 # Capacitor Native Update - Documentation
 
-> ⚠️ **IMPORTANT: Backend Infrastructure Required** ⚠️
-> 
-> This plugin requires you to build your own backend infrastructure including:
-> - Update server with API endpoints
-> - Bundle storage and CDN
-> - Signing and security services
-> 
+Welcome to the comprehensive documentation for **Capacitor Native Update**, a complete update lifecycle management solution for Capacitor applications.
 
-Welcome to the comprehensive documentation for **Capacitor Native Update**, a foundation plugin that provides architecture for a complete update lifecycle management solution for Capacitor applications.
+> **Dashboard & Management Platform**: [nativeupdate.aoneahsan.com](https://nativeupdate.aoneahsan.com)
+>
+> The platform provides a complete SaaS solution for managing your updates including:
+> - Web dashboard for app and build management
+> - Google Drive integration for secure build storage
+> - Channel management (production/staging/development)
+> - Gradual rollout capabilities
+> - Analytics and monitoring
 
 Created by **Ahsan Mahmood** and open-sourced for the developer community, this plugin combines three essential update features:
 
@@ -23,6 +24,13 @@ Created by **Ahsan Mahmood** and open-sourced for the developer community, this
 - [**Installation**](./getting-started/installation.md) - How to install and set up the plugin
 - [**Quick Start**](./getting-started/quick-start.md) - Get up and running in minutes
 - [**Configuration**](./getting-started/configuration.md) - Detailed configuration options
+- [**End-to-End Workflow**](./guides/end-to-end-workflow.md) - Complete setup to production guide
+
+### Dashboard & Management
+
+- [**Dashboard Guide**](./guides/dashboard-guide.md) - Complete dashboard user guide
+- [**Channel Management**](./guides/channel-management.md) - Production/staging/development channels
+- [**Admin Panel**](./guides/admin-panel.md) - Super-admin documentation
 
 ### Features
 
@@ -34,9 +42,10 @@ Created by **Ahsan Mahmood** and open-sourced for the developer community, this
 
 - [**Security Best Practices**](./guides/security-best-practices.md) - Implement secure updates
 - [**Key Management**](./guides/key-management.md) - Generate and manage signing keys
-- [**Migration from CodePush**](./guides/migration-from-codepush.md) - Migrate from CodePush
-- [**Testing Guide**](./guides/testing-guide.md) - Testing your update implementation
 - [**Deployment Guide**](./guides/deployment-guide.md) - Deploy to production
+- [**Testing Guide**](./guides/testing-guide.md) - Testing your update implementation
+- [**Troubleshooting**](./guides/troubleshooting.md) - Common issues and solutions
+- [**Migration from CodePush**](./guides/migration-from-codepush.md) - Migrate from CodePush
 
 ### API Reference
 

package/docs/cli-reference.md

@@ -11,10 +11,10 @@ The CLI is included with the native-update package. You can use it via npx witho
 npx native-update <command>
 
 # Or install globally
-npm install -g native-update
+yarn global add native-update
 
 # Or use locally in your project
-npm install native-update
+yarn add native-update
 npx native-update <command>
 ```
 
@@ -218,11 +218,11 @@ npx native-update backend create express --with-admin
 
 # 4. Start the backend (in another terminal)
 cd native-update-backend
-npm install
-npm run dev
+yarn install
+yarn dev
 
 # 5. Build your app
-npm run build
+yarn build
 
 # 6. Create and sign a bundle
 npx native-update bundle create ./www --version 1.0.1
@@ -292,7 +292,7 @@ chmod 600 ./keys/private-*.pem
 Ensure your web directory contains built files:
 ```bash
 # Build first
-npm run build
+yarn build
 
 # Then create bundle
 npx native-update bundle create ./www

package/docs/features/live-updates.md

@@ -370,7 +370,7 @@ async function getFeatureFlags() {
 
    ```bash
    # Use production builds
-   npm run build -- --mode production
+   yarn build -- --mode production
 
    # Enable compression
    gzip -9 bundle.js
@@ -548,8 +548,8 @@ Set up a local update server for testing:
 ```bash
 # See server-example directory
 cd server-example
-npm install
-npm run dev
+yarn install
+yarn dev
 ```
 
 ### Test Scenarios

package/docs/getting-started/installation.md

@@ -29,14 +29,6 @@ Before installing the plugin, ensure you have:
 
 ### 1. Install the Plugin
 
-Using npm:
-
-```bash
-npm install native-update
-```
-
-Using yarn:
-
 ```bash
 yarn add native-update
 ```
@@ -267,7 +259,7 @@ import type {
 ### Common Issues
 
 1. **"Module not found" error**
-   - Run `npm install` or `yarn install` again
+   - Run `yarn install` again
    - Delete `node_modules` and reinstall
    - Ensure you've run `npx cap sync`
 

package/docs/getting-started/quick-start.md

@@ -360,8 +360,8 @@ npx native-update backend create firebase --with-monitoring
 
 # Start the development server
 cd native-update-backend
-npm install
-npm run dev
+yarn install
+yarn dev
 ```
 
 ### Creating and Deploying Updates
@@ -374,7 +374,7 @@ npm run dev
 
 2. **Build and create update bundle**:
    ```bash
-   npm run build
+   yarn build
    npx native-update bundle create ./www --version 1.0.1
    ```
 

package/docs/guides/admin-panel.md

@@ -0,0 +1,268 @@
+# Admin Panel Documentation
+
+The Admin Panel provides super-administrator access to manage all users, apps, and builds across the Native Update platform.
+
+## Access Requirements
+
+The Admin Panel is only accessible to authorized administrators:
+
+- **Admin Email**: `aoneahsan@gmail.com`
+- **URL**: `https://nativeupdate.aoneahsan.com/admin`
+
+Non-admin users attempting to access `/admin` will be redirected to the regular dashboard.
+
+## Admin Panel Overview
+
+### Navigation
+
+| Section | Description |
+|---------|-------------|
+| **Overview** | Platform-wide statistics and recent activity |
+| **Users** | Manage all registered users |
+| **Apps** | View all applications across users |
+| **Builds** | Access all builds across the platform |
+
+### Accessing Admin Panel
+
+1. Login with the admin account
+2. Navigate to `/admin` or click the Admin link (if visible in navigation)
+3. The admin panel uses a distinct red theme to differentiate from the regular dashboard
+
+## Admin Overview
+
+**URL**: `/admin`
+
+### Platform Statistics
+
+The overview page displays aggregate metrics:
+
+| Metric | Description |
+|--------|-------------|
+| **Total Users** | All registered users on the platform |
+| **Total Apps** | All applications created |
+| **Total Builds** | All builds uploaded |
+| **Total Storage** | Combined storage used by all builds |
+
+### Recent Activity
+
+Shows the latest platform activity including:
+- New user registrations
+- New app creations
+- Recent build uploads
+
+Each activity item shows:
+- Activity type (user/app/build icon)
+- Name or identifier
+- Timestamp
+
+### Quick Actions
+
+Direct links to:
+- Manage Users
+- Manage Apps
+- Manage Builds
+- Return to Dashboard
+
+## User Management
+
+**URL**: `/admin/users`
+
+### User List
+
+View all registered users with:
+
+| Column | Description |
+|--------|-------------|
+| **User** | Avatar, display name, email, admin badge |
+| **Plan** | Current subscription (beta/pro/enterprise) |
+| **Apps** | Number of apps created |
+| **Builds** | Number of builds uploaded |
+| **Storage** | Storage space used |
+| **Created** | Registration date |
+| **Last Login** | Most recent login |
+
+### Search & Filter
+
+- Search by email or display name
+- Results update as you type
+
+### Pagination
+
+- 20 users per page
+- Navigate with Previous/Next buttons
+
+### Admin Badge
+
+Users with admin privileges display a shield icon next to their name.
+
+## App Management
+
+**URL**: `/admin/apps`
+
+### App List
+
+View all applications with:
+
+| Column | Description |
+|--------|-------------|
+| **App** | Icon and app name |
+| **Package ID** | Unique package identifier |
+| **Owner** | Email of the app owner |
+| **Builds** | Total number of builds |
+| **Platforms** | Supported platforms (iOS/Android/Web icons) |
+| **Created** | Creation date |
+
+### Search & Filter
+
+- Search by app name, package ID, or owner email
+- Results update as you type
+
+### Pagination
+
+- 20 apps per page
+- Navigate with Previous/Next buttons
+
+## Build Management
+
+**URL**: `/admin/builds`
+
+### Build List
+
+View all builds with:
+
+| Column | Description |
+|--------|-------------|
+| **Version** | Build version number |
+| **App** | Associated app name |
+| **Owner** | Email of the build owner |
+| **Channel** | Deployment channel (production/staging/development) |
+| **Platform** | Target platform |
+| **Status** | Build status (active/processing/failed/archived) |
+| **Size** | File size |
+| **Uploaded** | Upload date |
+| **Actions** | Download button |
+
+### Filters
+
+Multiple filter options available:
+
+- **Search**: Filter by version, app name, or owner email
+- **Channel**: All/Production/Staging/Development
+- **Platform**: All/iOS/Android/Web
+- **Status**: All/Active/Processing/Uploading/Failed/Archived
+
+### Clear Filters
+
+Click "Clear Filters" to reset all filters to default.
+
+### Build Actions
+
+- **Download**: Download the build file from Google Drive
+
+### Pagination
+
+- 20 builds per page
+- Navigate with Previous/Next buttons
+
+## Admin Responsibilities
+
+### Regular Monitoring
+
+Administrators should regularly:
+
+1. **Monitor User Growth**
+   - Track new registrations
+   - Identify unusual signup patterns
+
+2. **Monitor Storage Usage**
+   - Track total platform storage
+   - Identify users with excessive usage
+
+3. **Monitor Build Activity**
+   - Watch for failed builds
+   - Check for processing issues
+
+4. **Check Platform Health**
+   - Verify all services are operational
+   - Monitor error rates
+
+### User Support
+
+Administrators may need to:
+
+- Investigate user-reported issues
+- Verify build uploads
+- Check user permissions
+- Review app configurations
+
+### Security
+
+Administrators should:
+
+- Never share admin credentials
+- Regularly review access logs
+- Monitor for suspicious activity
+- Report security concerns immediately
+
+## Technical Details
+
+### Admin Detection
+
+Admin status is determined by:
+1. User's email matching `aoneahsan@gmail.com`
+2. `isAdmin` field in Firestore user document set to `true`
+
+### Data Access
+
+The admin panel fetches data without userId filters, allowing access to all documents:
+
+- Users: All documents in `users` collection
+- Apps: All documents in `apps` collection
+- Builds: All documents in `builds` collection
+
+### Security Rules
+
+Firestore security rules should ensure:
+- Only admin users can read all documents
+- Regular users can only read their own data
+- Write operations follow normal permission checks
+
+## Troubleshooting
+
+### Cannot Access Admin Panel
+
+1. Verify you're logged in with the admin email
+2. Check that `isAdmin` is set to `true` in Firestore
+3. Clear browser cache and try again
+4. Check browser console for errors
+
+### Data Not Loading
+
+1. Check network connection
+2. Verify Firestore rules allow admin access
+3. Check for JavaScript errors in console
+4. Try refreshing the page
+
+### Search Not Working
+
+1. Ensure search term is correct
+2. Check that data is loaded (not showing loading spinner)
+3. Search is case-insensitive
+
+## Future Enhancements
+
+Planned admin features:
+
+- [ ] User role management
+- [ ] App deletion/archival
+- [ ] Build cleanup tools
+- [ ] Platform settings management
+- [ ] Audit logs
+- [ ] Email notifications
+- [ ] Bulk operations
+
+## Related Documentation
+
+- [Dashboard Guide](./dashboard-guide.md) - Regular user dashboard
+- [Channel Management](./channel-management.md) - Managing update channels
+- [Security Best Practices](./security-best-practices.md) - Security guidelines