Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (54 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

79 lines (54 loc) · 2.29 KB

Contributing to Flow Browser

Project Structure

Directory Description
src/main Electron main process code
src/renderer Frontend React application
src/preload Preload scripts for secure IPC communication
src/shared Code shared between main and renderer
docs Documentation and guides

Prerequisites

Important

Electron uses node-gyp to build native modules.

You need to install some dependencies for node-gyp to work, or it might fail to build.

Getting Started

# Clone the repository
git clone https://github.com/MultiboxLabs/flow-browser.git
cd flow-browser

# Install dependencies
bun install

# Start the application in Preview Mode
bun start

# Development with hot reloading
bun dev

# Development with file watching (Recommended)
bun dev:watch

For more detailed development info, see the contributing documentation.

Using Extensions

From Chrome Web Store

  1. Navigate to the Chrome Web Store
  2. Browse and install extensions directly from the store

Building

There are different commands to build the application for different platforms.

bun build:win    # Windows
bun build:mac    # macOS
bun build:linux  # Linux

The build output will be in the ./dist directory.

Technology Stack

  • Frontend: React 19, TailwindCSS
  • Animation: Motion (imported from "motion/react")
  • UI Components: Radix UI
  • Build Tools: Electron Builder, electron-vite, Vite, TypeScript
  • Runtime: Electron 35 (Chromium)

Widevine VMP Signing (Advanced)

This build pipeline contains Widevine VMP Signing Capabilities. However, you will have to create an account in order to enable it.

Create an Account: https://github.com/castlabs/electron-releases/wiki/EVS#creating-an-evs-account

Once logged in, the app will be automatically VMP-signed, and you can enjoy Widevine Protected Content!