Introduction

Welcome to Peeka2, a modern file explorer and viewer built with Electron, TypeScript, and React.

What is Peeka2?

Peeka2 is a desktop application that provides an intuitive interface for browsing files and viewing various file formats with specialized renderers. It's designed to be fast, extensible, and user-friendly.

Key Features

• Cross-platform: Works on Windows, macOS, and Linux
• File Browser: Navigate your filesystem with ease
• Specialized Viewers: Built-in support for Markdown, JSON, and more
• Theme Support: Multiple built-in themes with customization options
• File Watching: Real-time updates when files change
• Favorites: Quick access to frequently used directories

Technology Stack

Peeka2 is built using modern web technologies:

• Electron: For cross-platform desktop support
• TypeScript: For type-safe development
• React: For the user interface
• Vite: For fast development and building
• Styled Components: For themeable CSS-in-JS styling

Getting Started

To get started with Peeka2, check out our Getting Started guide or jump straight to Installation.

Contributing

Peeka2 is open source! We welcome contributions from the community. Please see our Contributing Guide for more information.