Skip to content

lucainkwell/markview

Repository files navigation

image

🚀 Tauri + Next.js + Tailwind + Shadcn + Bun Boilerplate

Cross-platform desktop app boilerplate built using:

  • 🦀 Tauri for native desktop power (macOS, Windows, Linux)
  • Next.js as the frontend framework
  • 💨 Tailwind CSS for styling
  • Shadcn UI for beautiful, themeable components
  • ⚡️ Bun for ultra-fast tooling
  • 🧪 GitHub Actions for CI/CD on macOS, Windows, and Linux

🧠 Tech Stack

Layer Tech
Runtime Tauri
Frontend Next.js
Styling Tailwind CSS
Components Shadcn UI
Tooling Bun
CI/CD GitHub Actions (macOS, Windows, Linux)
Language TypeScript + Rust

Contribution Guide

Contributions are welcome! Feel free to open issues or submit pull requests.

Contributions for improving the dashboard, enhancing customizability, and adding new languages for multilingual support are particularly appreciated.

How to Contribute:

  1. Fork the repository to your GitHub account.

  2. Clone the repository to your local machine:

    git clone https://github.com/yourW-username/blink-eye.git
  3. Create a new branch for your changes:

    git checkout -b my-branch
  4. Make changes to the code.

  5. Commit your changes:

    git commit -m "commit message"
  6. Push your changes to the remote repository:

    git push origin my-branch
  7. Create a pull request on GitHub.

Application Setup

Prerequisites

  1. Tauri (for building the desktop app)
  2. Rust (for building the desktop app)
  3. Cargo (for package management)
  4. Bun (for package management)

To build and run Blink Eye (Desktop App):

  1. Install JavaScript dependencies:

    bun install
  2. Install all Cargo dependencies:

    cargo install --path src-tauri
  3. Run the app in development mode:

    bun run tauri dev

📁 Project Structure

.
├── app/                  # Next.js app directory
├── src-tauri/            # Tauri (Rust) backend
├── components/           # UI components (shadcn)
├── public/               # Static assets
├── styles/               # Tailwind CSS
├── .github/workflows/    # Cross-platform CI setup

🧪 GitHub Actions CI/CD

This repo includes a GitHub Actions workflow to build and test on:

  • 🍎 macOS
  • 🪟 Windows
  • 🐧 Linux

Builds are triggered on every push and PR. You can view the workflow file at:

.github/workflows/tauri.yml

You can customize this to add release signing, binary packaging, or auto-publish.


🌙 Theming

This boilerplate uses shadcn/ui and supports:

  • Light/dark theme toggle via ModeToggle
  • Tailwind + Radix for accessible, themeable components
  • Uses utility classes like bg-background, text-foreground, etc.

🧠 Learn More


📦 Build for Production

To build the Tauri app:

bun run tauri build

Or with npm:

npm run tauri build

To run in release mode:

bun run tauri dev

🤝 Contributing

PRs are welcome! Feel free to open issues or suggest improvements.


📄 License

MIT © nomandhoni-cs

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors