Ripple - GitLite

KO | EN

gitlite — search

#typescript #golang #android #machine-learning #deep-learning #linux #nodejs #macos #awesome #security #pytorch #ios #openai #open-source

Ripple

(★ 166)

A cross‑platform Dynamic Island for Windows, macOS, and Linux

파일 탐색기

최종 버전 다운로드 (.zip)

- - build.yml
- - main.js
  - preload.js
- App.css
- App.jsx
- Island.jsx
- main.js
- preload.js
.gitignore
CONTRIBUTING.md
entitlements.plist
forge.config.js
index.html
instructions.md
LICENSE
package-lock.json
package.json
README.md
vite.main.config.mjs
vite.preload.config.mjs
vite.renderer.config.mjs

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/TopMyster/Ripple

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd Ripple

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm install

package.json에 명시된 라이브러리들을 내려받아 설치합니다.

npm start

개발/실행 서버를 켭니다.

npm run make

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run make -- --platform=win32 --arch=x64

이 명령어를 터미널에 그대로 입력해 실행하세요.

npm run make -- --platform=linux --arch=x64

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Ripple

**Dynamic Island, but for everyone**

Ripple is a cross-platform desktop application that recreates Apple's Dynamic Island experience on Windows, Linux, and macOS. It's a notification hub, widget system, and smart assistant that stays out of your way until you need it.

<div align="center">

[![Discord](https://img.shields.io/badge/Discord-Join%20Us-5865F2)](https://discord.gg/a2xzVkxFVg)
[![License](https://img.shields.io/badge/License-MIT-green)](https://raw.githubusercontent.com/TopMyster/Ripple/main/LICENSE)
[![Version](https://img.shields.io/badge/Version-3.3.0-blue)](https://raw.githubusercontent.com/TopMyster/Ripple/main/package.json)

https://github.com/user-attachments/assets/a7b9ed8a-97b5-4603-bad7-6f4c4bef1f5d

</div>

---

## Features

### Core Functionality
- **Multi-Monitor & Desktop Support** — Island syncs seamlessly across all desktops and monitors
- **Media Controls** — Now playing preview with playback controls for your music
- **Customizable Themes** — Multiple themes including Win95, SleekBlack, and more
- **Quick Apps** — One-click access to 4 apps of your choice
- **Keyboard Shortcuts** — Quick navigation with Ctrl + number shortcuts

### Information & Alerts
- **Weather Display** — Real-time weather information
- **Battery Alerts** — Charging status and low battery notifications
- **Bluetooth Alerts** — Get notified when devices connect/disconnect

### Smart Features
- **AI Ask Feature** — Integrated AI assistant powered by Groq
- **Browser Search** — Quick search integration
- **Clipboard Manager** — Access your clipboard history
- **Tasks List** — Built-in task management

---

## Quick Start

### Installation

Download the latest release for your platform:
- **Windows**: `.exe` installer
- **macOS**: `.dmg` package (Intel & Apple Silicon supported)
- **Linux**: `.deb` or `.rpm` packages

[Download Latest Release](https://github.com/TopMyster/Ripple/releases)

### First Run
1. Install and launch Ripple
2. The Island will appear on your screen
3. **Click** the Island to open Large Mode
4. **Hover** over it to see Quick Mode
5. Visit **Settings** (last tab) to customize everything

---

## How to Use

### The Three Modes

**Still Mode** — The default idle state
- Compact display
- Minimal visual footprint
- Ready to expand on interaction

**Quick Mode** — Hover over the Island
- See current time, weather, and battery status
- If music is playing, view now-playing info
- Hover playback controls for music

**Large Mode** — Click the Island
- Full interface with all tabs
- Switch tabs with arrow keys or mouse scroll
- Access all features and settings
- Default view for focused work

### Using Tabs
- **Arrow Keys** — Navigate between tabs
- **Mouse Wheel** — Scroll horizontally between tabs
- **Ctrl + Number** — Jump to a specific tab

---

## Build & Development

### Prerequisites
- **Node.js** 16+ and npm
- Platform-specific build tools:
  - **Windows**: Visual Studio Build Tools
  - **macOS**: Xcode Command Line Tools
  - **Linux**: Build essentials (`build-essential` on Ubuntu/Debian)

### Development Setup

```bash
# Clone the repository
git clone https://github.com/TopMyster/Ripple.git
cd Ripple

# Install dependencies
npm install

# Start development server
npm start
```

The development server will launch Ripple with hot reload enabled. Press `Ctrl+R` (or `Cmd+R` on macOS) to refresh the app.

#### Build for Current OS
```bash
npm run make
```

#### Build for Specific Platforms

**Windows (x64)**
```bash
npm run make -- --platform=win32 --arch=x64
```

**Linux (x64)**
```bash
npm run make -- --platform=linux --arch=x64
```

**macOS (Apple Silicon)**
```bash
npm run make -- --platform=darwin --arch=arm64
```

**macOS (Intel)**
```bash
npm run make -- --platform=darwin --arch=x64
```

> **Linux Note**: Building Linux packages requires `dpkg`, `fakeroot`, and `rpm`:
> ```bash
> sudo apt-get install dpkg fakeroot rpm
> ```

**Output**: Compiled binaries are found in `out/make/`

---

## Contributing

We welcome contributions!:
- Bug reports and fixes
- New features and improvements
- Documentation updates
- Theme designs
- Ideas and suggestions

Please check [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.

---

## License

Ripple is open source and available under the [MIT License](LICENSE).

---