https://github.com/ahkohd/tauri-macos-spotlight-example

An example macOS Spotlight app built with Tauri
https://github.com/ahkohd/tauri-macos-spotlight-example

macos rust tauri tauri-template

Last synced: 11 days ago
JSON representation

An example macOS Spotlight app built with Tauri

• Host: GitHub
• URL: https://github.com/ahkohd/tauri-macos-spotlight-example
• Owner: ahkohd
• License: mit
• Created: 2023-01-06T22:06:19.000Z (almost 2 years ago)
• Default Branch: v1
• Last Pushed: 2024-09-01T20:56:44.000Z (2 months ago)
• Last Synced: 2024-10-19T13:38:51.682Z (22 days ago)
• Topics: macos, rust, tauri, tauri-template
• Language: Rust
• Homepage:
• Size: 9.99 MB
• Stars: 142
• Watchers: 6
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-tauri - tauri-macos-spotlight-example - Example macOS Spotlight app project. (Development / Integrations)

README

        
# Tauri macOS Spotlight Example

This is an example project that shows how to create a macOS Spotlight app using Tauri.

> Tauri 2.0 RC is now live! The [v2](https://github.com/ahkohd/tauri-macos-spotlight-example/tree/v2) branch includes a newer implementation of the spotlight app.

> Check out the [file-upload](https://github.com/ahkohd/tauri-macos-spotlight-example/tree/v1-file-upload) branch for an example of the spotlight app, now featuring file upload functionality. See it in action [here](https://github.com/ahkohd/tauri-macos-spotlight-example/issues/12#issuecomment-1826410794).

This template is based on Tauri + React + Typescript template. It should help get you started developing with Tauri, React and Typescript in Vite.

## Prerequisites

- _[Node.js](https://nodejs.org)_

- _[Tauri CLI](https://tauri.studio/docs/getting-started/installation)_

## Getting Started

1. Clone this repository:

```

git clone https://github.com/ahkohd/tauri-macos-spotlight-example.git

```

2. Navigate to the project directory:

```

cd tauri-macos-spotlight-example

```

3. Run the demo

```

pnpm install

pnpm tauri dev

```

4. Press Cmdk to toggle the spotlight window

![Demo](./demo.gif)

## Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)

# Related

The following are related to this project:

- [tauri-nspanel](https://github.com/ahkohd/tauri-nspanel/tree/main/examples/vanilla): Tauri plugin to convert a window to panel.

- [tauri-plugin-spotlight](https://github.com/zzzze/tauri-plugin-spotlight): Tauri plugin that provides a MacOS Spotlight-like search functionality for Tauri windows.

# License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE.md) file for details.