Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jetli/rust-yew-realworld-example-app

Exemplary real world app built with Rust + Yew + WebAssembly, by Function Components + Hooks, also supports desktop by Tauri.
https://github.com/jetli/rust-yew-realworld-example-app

desktop hooks react realworld rust tauri wasm web webassembly yew

Last synced: about 1 month ago
JSON representation

Exemplary real world app built with Rust + Yew + WebAssembly, by Function Components + Hooks, also supports desktop by Tauri.

Host: GitHub
URL: https://github.com/jetli/rust-yew-realworld-example-app
Owner: jetli
License: apache-2.0
Created: 2019-11-04T03:57:57.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-05-01T01:13:39.000Z (6 months ago)
Last Synced: 2024-09-26T19:09:15.727Z (about 1 month ago)
Topics: desktop, hooks, react, realworld, rust, tauri, wasm, web, webassembly, yew
Language: Rust
Homepage: https://jetli.github.io/rust-yew-realworld-example-app/
Size: 16.9 MB
Stars: 856
Watchers: 17
Forks: 110
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-yew - Realworld example - Exemplary real world app built with Rust + Yew + WebAssembly. It utilizes Yew's latest `function components` and `hooks`. It also supports desktop application powered by [Tauri](https://github.com/tauri-apps/tauri). (Projects)

README

        # ![RealWorld Example App](logo.png)

[![Continuous Integration](https://github.com/jetli/rust-yew-realworld-example-app/workflows/build/badge.svg)](https://github.com/jetli/rust-yew-realworld-example-app/actions)

[![RealWorld Frontend](https://img.shields.io/badge/realworld-frontend-%23783578.svg)](http://realworld.io)

> [Rust] + [Yew] + [WebAssembly] codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld] spec and API.

## [Demo]    [RealWorld]

This codebase was created to demonstrate a fully fledged [WebAssembly] web application built with [Yew] including CRUD operations, authentication, routing, pagination, and more. It utilizes Yew's latest `function components` and `hooks`. It also supports desktop application powered by [Tauri].

We've gone to great lengths to adhere to the [Yew] community styleguides & best practices.

For more information on how to this works with other frontends/backends, head over to the [RealWorld] repo.

## How it looks

You can view a live demo over at [Demo]

| Home(Web) | Article(Web) |

| :---:         |     :---:      |

| ![Home](screenshots/home.png) | ![Article](screenshots/article.png) |

| Edit(Desktop) | Sign Up(Desktop) |

| :---:         |     :---:      |

| ![Edit](screenshots/edit.png) | ![Sign Up](screenshots/sign_up.png) |

## How it works

This is an application written in [Rust] that utilizes [Yew] and [WebAssembly] for developing the frontend web app that powers the RealWorld application.

You can view a full list of crates being used in [Cargo.toml], but here are some of the main ones of note:

* [yew] - a modern Rust framework for creating multi-threaded frontend apps with WebAssembly.

* [yew-router] - a routing library for the [Yew] framework.

* [yew-hooks] - Hooks for the [Yew] web framework, inspired by react hook libs like [streamich/react-use] and [alibaba/hooks].

* [lazy_static] - a macro for declaring lazily evaluated statics in Rust.

* [parking_lot] - provides implementations of `Mutex`, `RwLock`, `Condvar` and `Once` etc.

* [pulldown-cmark] - a pull parser for CommonMark, used to parse Markdown.

* [serde] - a generic serialization/deserialization framework.

* [chrono] - date and time library for Rust.

## Getting started

### With Docker

```bash

docker-compose up

```

You can visit `http://127.0.0.1:8080` in your browser now.

### Manually

* Install [Rust]

* Install [wasm-pack]

  ```bash

  cargo install wasm-pack

  ```

* Install [trunk]

* Build and develop

  Copy `.env.example` to `.env`, and you can change the environment variables if you like.

  ```bash

  cp .env.example .env

  cd crates/conduit-wasm && trunk serve

  ```

  You can visit `http://127.0.0.1:8080` in your browser now.

* Build and release

  ```bash

  cd crates/conduit-wasm && trunk build

  ```

  You should find static files at `crates/conduit-wasm/dist` folder now, they are hosted in [gh-pages] branch as a demo.

* Test

  Install [chromedriver], run tests in headless browsers.

  ```bash

  wasm-pack test --headless --chrome

  ```

* Justfile

  * Install [wasm-pack] `just install-wasm-pack`

  * Copy `.env.example` to `.env` `just env`

  * Trunk serve `just trunk-serve`

  * Trunk build `just trunk-build`

  * Test `just test`

### With [Tauri] for desktop (optional)

* Install [Tauri]

  ```bash

  cargo install tauri-cli

  ```

* Build and develop for desktop

  ```bash

  cargo tauri dev

  ```

* Build and release for desktop

  ```bash

  cargo tauri build

  ```

  

* Justfile

  * Install [Tauri] `just install-tauri`

  * Build and develop `just tauri-dev`

  * Build and release `just tauri-build`

## Create Yew App

This project was bootstrapped with [Create Yew App], if you want to quickly setup a new Yew web app for your own, you might try [Create Yew App], an unofficial tool to set up a modern Yew web app by simply running one command.

```bash

npx create-yew-app my-app

cd my-app

trunk serve

```

Justfile:

* Create-yew-app `just create-yew-app`

* App-serve `just app-serve`

## Contributing

Feel free to take a look at the current issues in this repo for anything that currently needs to be worked on.

You are also welcome to open a PR or a new issue if you see something is missing or could be improved upon.

## License

Apache License (Version 2.0)

See [LICENSE] for details

[chromedriver]: http://chromedriver.chromium.org/downloads

[chrono]: https://github.com/chronotope/chrono

[Cargo.toml]: ./crates/conduit-wasm/Cargo.toml

[Create Yew App]: https://github.com/jetli/create-yew-app

[Demo]: https://jetli.github.io/rust-yew-realworld-example-app/

[gh-pages]: https://github.com/jetli/rust-yew-realworld-example-app/tree/gh-pages

[lazy_static]: https://github.com/rust-lang-nursery/lazy-static.rs

[LICENSE]: ./LICENSE

[parking_lot]: https://github.com/Amanieu/parking_lot

[pulldown-cmark]: https://github.com/raphlinus/pulldown-cmark

[RealWorld]: https://github.com/gothinkster/realworld

[Rust]: https://www.rust-lang.org/

[serde]: https://github.com/serde-rs/serde

[WebAssembly]: https://webassembly.org

[wasm-pack]: https://github.com/rustwasm/wasm-pack

[Yew]: https://github.com/yewstack/yew

[yew-router]: https://github.com/yewstack/yew

[yew-hooks]: https://github.com/jetli/yew-hooks

[streamich/react-use]: https://github.com/streamich/react-use

[alibaba/hooks]: https://github.com/alibaba/hooks

[Tauri]: https://github.com/tauri-apps/tauri

[trunk]:https://trunkrs.dev