https://github.com/tejastn10/hollow
A modern, Electron-based network packet analyzer with a sleek UI, built using TypeScript and React. Designed as a Wireshark alternative for real-time packet inspection and analysis.
https://github.com/tejastn10/hollow
electron networking type vite
Last synced: about 2 months ago
JSON representation
A modern, Electron-based network packet analyzer with a sleek UI, built using TypeScript and React. Designed as a Wireshark alternative for real-time packet inspection and analysis.
- Host: GitHub
- URL: https://github.com/tejastn10/hollow
- Owner: tejastn10
- License: mit
- Created: 2025-03-17T13:53:30.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-18T03:32:28.000Z (11 months ago)
- Last Synced: 2025-07-18T07:20:56.403Z (11 months ago)
- Topics: electron, networking, type, vite
- Language: TypeScript
- Homepage:
- Size: 462 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Hollow ⧲
**Hollow** is a modern network protocol analyzer and packet sniffer built with Electron, React, and TypeScript. Designed as an alternative to Wireshark, it provides a user-friendly interface for real-time network traffic analysis, packet inspection, and protocol dissection. With performance and developer experience in mind, it offers a modern approach to network monitoring and troubleshooting.
---
## Features 🌟
- **Live Packet Capture**: Real-time capture from network interfaces
- **Protocol Analysis**: Support for common protocols (TCP, UDP, HTTP, etc.)
- **Packet Filtering**: Advanced filtering system using display filters
- **Statistics & Visualization**: Real-time traffic statistics and graphs
- **Cross-platform Support**: Works on Windows, macOS, and Linux
- **Modern Interface**: Built with React for smooth user experience
---
## Getting Started 🚀
### Prerequisites
Ensure you have the following installed:
- **Node.js**: v22 or later
- **npm**: v8 or later
---
### Installation ⚙️
1. Clone the repository:
```bash
git clone https://github.com/tejastn10/hollow.git
cd hollow
```
2. Install dependencies:
```bash
npm install
```
3. Start the development server:
```bash
npm run dev
```
4. Your Electron app should launch automatically in development mode.
---
## Development Workflow 💻
### IDE Setup
For the best development experience, we recommend:
- [VSCode](https://code.visualstudio.com/) with the following extensions:
- [BiomeJs](https://marketplace.visualstudio.com/items?itemName=biomejs.biome)
### Available Scripts
- **Development Mode**:
```bash
npm run dev
```
- **Type Checking**:
```bash
npm run typecheck
```
- **Linting**:
```bash
npm run lint
```
- **Formatting**:
```bash
npm run format
```
---
## Building for Production 🏗️
Hollow comes with pre-configured build scripts for all major platforms:
### Windows
```bash
npm run build:win
```
### macOS
```bash
npm run build:mac
```
### Linux
```bash
npm run build:linux
```
### All Platforms
```bash
npm run build
```
Build outputs will be available in the `dist` directory.
---
## Project Structure 📁
```bash
hollow/
├── .husky/ # Git hooks configuration
│ ├── _/ # Husky internals
│ ├── commit-msg # Commit message validation hook
│ └── pre-commit # Pre-commit hook
├── build/ # Build-related files
│ ├── entitlements.mac.plist # macOS app entitlements
│ ├── icon.icns # macOS app icon
│ ├── icon.ico # Windows app icon
│ └── icon.png # Generic app icon
├── out/ # Build output directory
│ ├── main/ # Main process compiled files
│ └── preload/ # Preload scripts
├── resources/ # Resource files
│ └── icon.png # Application icon
├── src/ # Source code
├── .gitignore # Git ignore configuration
├── .commitlintrc.yml # Commitlint configuration
├── .nvmrc # Node version manager config
├── dev-app-update.yml # Auto-updater dev configuration
├── electron-builder.yml # Electron builder configuration
├── biome.json # Biome configuration
├── LICENSE.md # License file
├── package.json # Project dependencies and scripts
├── package-lock.json # Locked dependencies
├── README.md # Project documentation
├── tsconfig.json # Main TypeScript configuration
└── vite.config.ts # Vite configuration
```
---
## Customization 🔧
### Application Information
To customize your application details, modify the following files:
- `package.json`: Update name, description, version, and author
- `electron-builder.json`: Configure build options for different platforms
### Styling and Theming
The project includes minimal styling to get you started. Feel free to integrate your preferred
styling solution:
- CSS/SCSS Modules
- Styled Components
- Tailwind CSS
- Material UI or other component libraries
---
## License 📜
This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.
---
## Acknowledgments 🙌
- Built with **Electron** for cross-platform desktop applications
- Powered by **Vite** for lightning-fast development
- Strengthened with **TypeScript** for robust applications
- Made with ❤️ for developers who want to build desktop apps with web technologies