Skip to content
Exemplary real world app built with Rust + Yew + WebAssembly
Rust Other
  1. Rust 99.3%
  2. Other 0.7%
Branch: master
Clone or download
Latest commit df846ce Jan 19, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update cd.yml Jan 14, 2020
crates
screenshots Update screenshots for desktop Jan 3, 2020
.gitignore
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Dec 17, 2019
Cargo.toml [ADD] Add standalone desktop by web-view #2 Dec 19, 2019
LICENSE Initial commit Nov 4, 2019
README.md Introduce Create Yew App Jan 19, 2020
logo.png Add files via upload Nov 4, 2019
package.json Remove cargo-web, use npm and parcel for bundling Jan 3, 2020
rust-toolchain Remove cargo-web, use npm and parcel for bundling Jan 3, 2020
rustfmt.toml add Home page layout Nov 5, 2019

README.md

RealWorld Example App

Continuous Integration RealWorld Frontend

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.

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 Article
Edit(Desktop) Sign Up(Desktop)
Edit Sign Up

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.
  • 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

  • Install Rust

  • Install wasm-pack

    cargo install wasm-pack
    
  • Install node

  • Install npm packages

    npm run install
    
  • Build and develop

    npm start
    

    You can visit http://localhost:8000 in your browser now.

  • Build and release

    npm run build
    

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

  • Build and develop for desktop

    If you're planning on targeting Linux you must ensure that Webkit2gtk is already installed and available for discovery via the pkg-config command.

    sudo apt-get update
    sudo apt-get install libwebkit2gtk-4.0-37 libwebkit2gtk-4.0-dev
    
    npm run build:webview
    cargo run -p conduit-webview
    

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.

npx create-yew-app my-app
cd my-app
npm start

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

You can’t perform that action at this time.