Skip to content

TailYew helps you ship fast, beautiful Yew apps using fully-styled, accessible components with dark mode, markdown rendering, charts, modals, and form elements — all built in idiomatic Rust.

License

Notifications You must be signed in to change notification settings

apjames93/tailyew

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Crates.io Docs.rs License

🌬️ TailYew

The Tailwind + Yew component system — built entirely in Rust.

TailYew is an open-source component system for Yew apps, built using idiomatic Rust and styled with Tailwind CSS. This repo includes the component crate, full demo/docs site, and the scaffolding CLI.

🎯 This README is for contributors. If you want to use TailYew in your project, check the crate README or the create-tailyew-app CLI to get started.


🛠️ Local Setup

This repo is a monorepo with:

  • crates/tailyew/ – the component crate (tailyew)
  • frontend/ – the live demo and docs site (Yew + WASM)
  • crates/create-tailyew-app/ – CLI for scaffolding new TailYew projects

You’ll need:

  • Rust + WASM toolchain (rustup, wasm32-unknown-unknown, etc.)
  • Node.js (for Tailwind CSS + dev server)
  • make (used for all common workflows)

✅ Getting Started

Clone the repo and enter it:

git clone https://github.com/apjames93/tailyew.git
cd tailyew

Then:

# Install all Rust deps
cargo check

# Install required Node packages for the frontend
cd frontend
npm install
cd ..

# Run the full docs site with hot reload (frontend + component crate)
make run-frontend

You can now open http://localhost:8080 and see the live docs site running.


🧪 Common Dev Commands

make run-frontend     # Run frontend + crate (hot reload)
make pretty           # Format + lint everything
make watch-docs       # Watch + build Rust docs (crates/tailyew/docs.rs)

Need to run something just in the frontend?

make fe-build
make fe-run

Or just in the crate?

make tailyew-doc
make tailyew-test

🗂️ Folder Structure

.
├── crates/
│   ├── tailyew/               # Main component system crate
│   └── create-tailyew-app/   # CLI to scaffold new apps
├── frontend/                  # Demo/docs site (Yew + Tailwind)
├── docs/                      # GitHub Pages markdown (optional)
├── Makefile                   # Root orchestrator (delegates to subdirs)

✅ Contribution Checklist

Before submitting a PR:

  • ✅ Run make pretty (formats + lints)
  • ✅ Run make release-check
  • ✅ Test both light mode and dark mode
  • ✅ Update related demo pages in frontend/src/pages/
  • ✅ Include before/after screenshots for visual changes

📂 Helpful Links


🙌 Thank You

Whether you're submitting a PR, filing an issue, or just exploring the project — thank you for helping us grow the Rust UI ecosystem.


🔗 Related

About

TailYew helps you ship fast, beautiful Yew apps using fully-styled, accessible components with dark mode, markdown rendering, charts, modals, and form elements — all built in idiomatic Rust.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published