Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jetli/create-yew-app
Set up a modern Yew web app by running one command.
https://github.com/jetli/create-yew-app
create-yew-app rust wasm wasm-bindgen wasm-pack webassembly yew
Last synced: 3 months ago
JSON representation
Set up a modern Yew web app by running one command.
- Host: GitHub
- URL: https://github.com/jetli/create-yew-app
- Owner: jetli
- License: apache-2.0
- Created: 2019-12-21T20:07:56.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-26T11:29:24.000Z (6 months ago)
- Last Synced: 2024-07-10T19:15:27.318Z (4 months ago)
- Topics: create-yew-app, rust, wasm, wasm-bindgen, wasm-pack, webassembly, yew
- Language: Rust
- Homepage: https://jetli.github.io/create-yew-app/
- Size: 3.92 MB
- Stars: 163
- Watchers: 3
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-yew - Create Yew App - Set up a modern Yew web app by running one command, `npx create-yew-app my-app`. (Templates)
README
# Create Yew App
Create Yew apps with no build configuration.
- [Creating an App](#creating-an-app) – How to create a new app.
- [Yew](https://github.com/yewstack/yew) - Rust / Wasm framework for building client web apps.
- [Awesome Yew](https://github.com/jetli/awesome-yew) - A curated list of awesome things related to Yew / WebAssembly.
- [Realworld example](https://github.com/jetli/rust-yew-realworld-example-app) - Exemplary real world app built with Rust + Yew + WebAssembly.
[Check out a live demo](https://jetli.github.io/create-yew-app/) powered by Create Yew App.
## Quick Overview
```sh
npx create-yew-app my-app
cd my-app
trunk serve
```
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
Then open [http://localhost:8080/](http://localhost:8080/) to see your app.
When you’re ready to deploy to production, create a minified bundle with `trunk build`.
## Getting Started
### Install Rust wasm target
```sh
rustup target add wasm32-unknown-unknown
```
### Install [Trunk](https://trunkrs.dev).
## Creating an App
**You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine** (but it’s not required on the server). You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects.
To create a new app, you may choose one of the following methods:
### npx
```sh
npx create-yew-app my-app
```
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is a package runner tool that comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
### npm
```sh
npm init yew-app my-app
```
_`npm init ` is available in npm 6+_
### Yarn
```sh
yarn create yew-app my-app
```
_[`yarn create `](https://yarnpkg.com/lang/en/docs/cli/create/) is available in Yarn 0.25+_
### Project structure
It will create a directory called `my-app` inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
```
my-app
├── README.md
├── .gitignore
├── Cargo.toml
├── index.html
├── LICENSE-APACHE
├── LICENSE-MIT
├── tailwind.config.js
├── tailwind.css
├── Trunk.toml
├── public
│ ├── favicon.ico
│ ├── logo.svg
└── src
├── lib.rs
├── main.rs
├── app
│ ├── about.rs
│ ├── home.rs
│ └── mod.rs
└── components
├── nav.rs
└── mod.rs
```
No configuration or complicated folder structures, only the files you need to build your app.
Once the installation is done, you can open your project folder:
```sh
cd my-app
```
Inside the newly created project, you can run some built-in commands:
### `trunk serve`
Runs the app in development mode.
Open [http://localhost:8080](http://localhost:8080) to view it in the browser.
The page will automatically reload if you make changes to the code.
You will see the build errors and lint warnings in the console.
### `trunk build`
Builds the app for production to the `dist` folder.
It correctly bundles Yew in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed.
### `wasm-pack test --headless --chrome`
Runs the test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.
# 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](./LICENSE) for details.