https://github.com/osama-yusuf/repo-radar
Your Mission Control Center for GitHub Repositories Changes, Automate actions like running bash scripts or sending webhooks for seamless repository change management.
https://github.com/osama-yusuf/repo-radar
automated-workflows change-detection developer-tools github-monitoring open-source-tools repository-tracking
Last synced: 3 months ago
JSON representation
Your Mission Control Center for GitHub Repositories Changes, Automate actions like running bash scripts or sending webhooks for seamless repository change management.
- Host: GitHub
- URL: https://github.com/osama-yusuf/repo-radar
- Owner: Osama-Yusuf
- License: mit
- Created: 2024-12-13T00:22:36.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-30T13:32:00.000Z (3 months ago)
- Last Synced: 2025-03-30T14:26:57.712Z (3 months ago)
- Topics: automated-workflows, change-detection, developer-tools, github-monitoring, open-source-tools, repository-tracking
- Language: JavaScript
- Homepage:
- Size: 1.17 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🛰️ Repo Radar
> Your Mission Control Center for GitHub Repositories
## 🎯 What is Repo Radar?
Repo Radar is your intelligent GitHub repository monitoring system that keeps you in sync with repository changes and automates responses. Think of it as your personal watchtower that never sleeps!
🔬 **Want to dive deep into the monitoring magic?** Check out our [Backend Documentation](backend/README.md) to explore the intricate details of how Repo Radar keeps your repositories under constant surveillance.
### 🌟 Key Features
- **🔍 Real-time Monitoring**
- Track multiple repositories and branches
- Configurable check intervals
- Instant change detection
- **🎬 Automated Actions**
- **Webhooks**: Trigger HTTP notifications
- **Custom Scripts**: Run your own automation scripts
- **Environment Variables**: Secure secrets management
- **📊 Smart Dashboard**
- Beautiful Material UI interface
- Real-time status updates
- Comprehensive activity logs
## 📸 Screenshots
## 🚀 Quick Start
### 🐳 Installation Using Docker
### Prerequisites
- Docker
- Docker Compose
- GitHub Personal Access Token
1. **Clone the repository**
```bash
git clone https://github.com/Osama-Yusuf/repo-radar.git
cd repo-radar
```
2. **Update .env file**
```bash
cp .env.example .env # Configure your envs
```
3. **Build and Run Docker Compose**
```bash
docker compose build
docker compose up -d
```
### 📦 Installation Using NPM
### Prerequisites
- Node.js ≥ 16.0.0
- GitHub Personal Access Token
1. **Clone the repository**
```bash
git clone https://github.com/Osama-Yusuf/repo-radar.git
cd repo-radar
```
2. **Backend Setup**
```bash
cd backend
npm install
cp .env.example .env # Configure your envs
npm run dev
```
3. **Frontend Setup**
```bash
cd ../frontend
npm install
cp .env.example .env # Configure your envs
npm run dev
```
4. Open `http://localhost:5173` in your browser
## 🎮 How to Use
1. **Add a Repository**
- Click "Add Project"
- Enter repository URL
- Specify branches to monitor
- Set check interval
2. **Create Actions**
- Add webhooks or scripts
- Configure environment variables
- Actions trigger on changes
3. **Monitor Changes**
- View real-time status
- Check commit history
- Review action logs
## 🏗️ Architecture
- **Frontend**: React + Material UI
- **Backend**: Node.js + Express
- **Database**: SQLite
- **API**: GitHub REST API v3
## 🛡️ Security
- Secure secrets management
- HTTPS webhook endpoints only
- Sandboxed script execution
- Environment variables protection
## 🤝 Contributing
We love contributions! Check out our [Contributing Guide](CONTRIBUTING.md) for guidelines.
## 📜 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- Built with [Material-UI](https://mui.com/)
- Powered by [GitHub API](https://docs.github.com/en/rest)
- Inspired by the need for better repository monitoring
---
Made with ❤️ for developers who love automation