yew README

The project's README from github.com/yewstack/yew. As one markdown file: README.md.

Yew

Rust / Wasm client web app framework

Crate Info API Docs Discord Chat

Documentation (stable) | Documentation (latest) | Examples | Changelog | Roadmap | 简体中文文档 | 繁體中文文檔 | ドキュメント

About

Yew is a modern Rust framework for creating multi-threaded, front-end web apps with WebAssembly.

Yew is named after a type of evergreen tree, and is pronounced /juː/. Entry with audio on Cambridge Dictionary.

Contributing

Yew is a community-driven effort and we welcome all kinds of contributions, big or small, from developers of all backgrounds. We want the Yew community to be a fun and friendly place, so please review our Code of Conduct to learn what behavior will not be tolerated.

🤠 New to Yew?

Start learning about the framework by helping us improve our documentation. Pull requests which improve test coverage are also very welcome.

😎 Looking for inspiration?

Check out the community curated list of awesome things related to Yew / WebAssembly at jetli/awesome-yew.

🤔 Confused about something?

Feel free to drop into our Discord chatroom or open a new "Question" issue to get help from contributors. Often questions lead to improvements to the ergonomics of the framework, better documentation and even new features!

🙂 Ready to dive into the code?

After reviewing the Contribution Guide, check out the "Good First Issues" (they are eager for attention!). Once you find one that interests you, feel free to assign yourself to an issue and don't hesitate to reach out for guidance, the issues vary in complexity.

😱 Found a bug?

Please report all bugs! We are happy to help support developers fix the bugs they find if they are interested and have the time.

Contributors

Code Contributors

This project exists thanks to all the people who contribute.

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

yew (yewstack/yew)

frontend-framework
Searching Database…

32.8K ·GitHub
What is this?Yew is a modern Rust framework for creating multi-threaded, front-end web apps with WebAssembly. You build the UI in Rust, and the app compiles to Wasm that runs in the browser.
Is it a front-end framework or a full-stack one?Front-end only: Yew targets the browser via WebAssembly. It is not JavaScript-based — you declare interactive HTML with Rust expressions through a macro, in a component style close to React.
How do I get a first app running?The README itself has no install steps and sends newcomers to the framework documentation. The getting-started guide at yew.rs walks you through installing Rust, adding the wasm32-unknown-unknown target and the Trunk bundler, then building the sample app.
Do I need React or JSX experience to pick it up?Not required, but it transfers directly: the README says developers experienced with JSX in React should feel quite at home, since Yew's HTML macro works the same way. Rust is the real prerequisite.
Do I have to give up npm packages and my existing JavaScript code?No. Yew supports JavaScript interoperability, so you can leverage NPM packages and integrate Yew into existing JavaScript applications.
Who is it for, and what is the pitch over a typical JS framework?Rust developers building front-ends who want speed: Yew achieves high performance by minimizing DOM API calls on each page render and makes it easy to offload processing to background web workers.
What is the deal with the name Yew?It is named after a type of evergreen tree and is pronounced /juː/ — like 'you'. The README even links an audio entry in the Cambridge Dictionary.
Is Yew built by a company or by the community?Community-driven: the README welcomes contributions big and small from developers of all backgrounds, runs a Discord chatroom for questions, and points newcomers to Good First Issues of varying complexity.
Where can I find curated examples and libraries for Yew?The README points to jetli/awesome-yew, a community-curated list of awesome things related to Yew and WebAssembly.
Is it free to use, including commercially?Yes. The repo is published under the Apache-2.0 license, so it is free for personal and commercial use.
What are similar projects?leptos, perry, solid, uikit, qwik, riot, nuxt, dva
Creator
yewstack
Size
21.5 MB
Stars
32.8K
Age
8y
Commits · 90 Days