🔔 FCMPanel

A Modern Firebase Cloud Messaging Dashboard

Secure, scalable, and user-friendly Firebase Cloud Messaging management platform with multi-account support

🚀 Quick Start • 📖 Documentation • 🐛 Report Bug • 💡 Request Feature • 🤝 Contributing

---

🌟 Overview

FCMPanel is a comprehensive web-based dashboard designed to simplify Firebase Cloud Messaging (FCM) management. Whether you're managing a single app or multiple projects, FCMPanel provides an intuitive interface to send notifications, manage devices, and track messaging history across multiple Firebase accounts.

✨ Key Features

Feature	Description
🔐 Secure Authentication	JWT-based authentication with role-based access control
🏢 Multi-Account Support	Manage multiple Firebase projects from a single dashboard
📱 Device Management	Register, track, and manage FCM-enabled devices
📢 Topic Broadcasting	Send notifications to topic-subscribed devices
🎯 Targeted Messaging	Send direct notifications to specific devices
📊 Analytics & History	Comprehensive notification tracking and statistics
🔒 Enterprise Security	Encrypted credential storage with multiple security layers
🌐 RESTful API	Full API access for programmatic integration

🚀 Quick Start

Prerequisites

• Node.js (v20.0.0 or higher)
• npm or yarn
• Firebase Project with FCM enabled
• Firebase Service Account credentials

⚡ Installation

1. Clone the repository

   git clone https://github.com/moonshadowrev/FCMPanel.git
   cd FCMPanel

2. Install dependencies

   npm install
   # or
   yarn install

3. Environment setup

   cp .env.example .env
   # Edit .env with your configuration

4. Database setup

   npm run migrate
   npm run seed

5. Start the application

   # Development
   npm run dev
   
   # Production
   npm start

6. Access the dashboard

   http://localhost:3000
   

🔑 Default Credentials

After seeding, use these credentials for initial access:

• Username: admin
• Password: Admin123!

⚠️ Security Note: Change these credentials immediately after first login!

📋 Environment Configuration

Create a .env file with the following variables:

# Server Configuration
PORT=3000
NODE_ENV=development

# Security
SESSION_SECRET=your-super-secret-session-key
JWT_SECRET=your-jwt-secret-key
JWT_EXPIRE=1d
JWT_COOKIE_EXPIRE=1

# Encryption (32 characters for AES-256)
ENCRYPTION_KEY=your-32-character-encryption-key

# Device Registration API
DEVICE_REGISTRATION_API_KEY=your-device-api-key

# reCAPTCHA v2 (optional)
RECAPTCHA_SITE_KEY=your-recaptcha-site-key
RECAPTCHA_SECRET_KEY=your-recaptcha-secret-key

# Optional: Default Firebase Config
# FIREBASE_PROJECT_ID=your-project-id
# FIREBASE_CLIENT_EMAIL=your-service-account-email
# FIREBASE_PRIVATE_KEY="your-private-key"

🏗️ Architecture

FCMPanel/
├── 📁 config/          # Configuration files
├── 📁 middleware/      # Express middleware
├── 📁 models/          # Database models
├── 📁 routes/          # API routes
├── 📁 views/           # EJS templates
├── 📁 public/          # Static assets
├── 📁 scripts/         # Utility scripts
└── 📁 docs/            # Documentation

🚀 API Reference

Device Management

• POST /api/devices/register - Register a new device

🛡️ Security Features

FCMPanel implements enterprise-grade security:

• 🔐 JWT Authentication with refresh tokens
• 🔒 AES-256 Encryption for sensitive data
• 🛡️ CSRF Protection on all forms
• ⏱️ Rate Limiting to prevent abuse
• 🔧 Helmet.js for HTTP headers security
• 🍪 Secure Cookies with HttpOnly flags
• 🔑 bcrypt password hashing

🧪 Development

Available Scripts

Command	Description
npm start	Start production server
npm run dev	Start development server with hot reload
npm run migrate	Run database migrations
npm run migrate:reset	Reset database (⚠️ destroys data)
npm run seed	Seed database with initial data
npm run demo-data	Generate demo data for testing

🔧 Development Setup

1. Fork the repository
2. Create a feature branch

   git checkout -b feature/amazing-feature

3. Make changes and test
4. Commit with conventional commits

   git commit -m "feat: add amazing feature"

5. Push and create a Pull Request

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

📋 How to Contribute

1. 🍴 Fork the repository
2. 🌟 Star the project (it helps!)
3. 📝 Create an issue for bugs or features
4. 🔧 Submit a pull request

🎯 Areas for Contribution

• 🐛 Bug fixes and improvements
• ✨ New features and enhancements
• 📚 Documentation improvements
• 🧪 Test coverage expansion
• 🌐 Internationalization (i18n)

📚 Documentation

• 📖 Full Documentation
• 🗃️ Wiki Pages
• 🔒 Security Guide

🗺️ Roadmap

• 📊 Advanced analytics dashboard
• 🌐 Multi-language support
• 🔗 Webhook integrations
• 📱 Progressive Web App (PWA)

🙏 Acknowledgments

• Firebase Admin SDK
• Express.js
• Sequelize ORM
• All our amazing contributors

🛟 Support

• 📝 Create an Issue
• 💬 Discussions

📄 License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

---

⭐ If FCMPanel helped you, please consider giving it a star! ⭐

Made with ❤️ by moonshadowrev

🔝 Back to Top