leptos/examples
2024-09-14 21:22:16 -04:00
..
action-form-error-handling fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
axum_js_ssr chore(examples): SsrMode is no longer clone (#2954) 2024-09-08 19:39:15 -04:00
cargo-make feat: Add Compression to Hacker News w/ Islands Example (#2613) 2024-06-28 15:01:05 -04:00
counter fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
counter_isomorphic fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
counter_url_query fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
counter_without_macros fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
counters docs: update main documentation of leptos crate (#2853) 2024-08-28 07:44:29 -04:00
directives fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
error_boundary chore: upgrade dependencies (#2765) 2024-08-10 20:01:41 -04:00
errors_axum fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
fetch chore: upgrade dependencies (#2765) 2024-08-10 20:01:41 -04:00
gtk examples: fix/update GTK example, and remove web parallels (#2839) 2024-08-14 19:47:33 -04:00
hackernews fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
hackernews_axum fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
hackernews_islands_axum fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
hackernews_js_fetch fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
islands fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
islands_router fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
js-framework-benchmark chore: upgrade dependencies (#2765) 2024-08-10 20:01:41 -04:00
parent_child fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
portal fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
router feat: restore hot reloading for 0.7 (#2775) 2024-08-12 16:11:30 -04:00
server_fns_axum Add support for postcard codec in server_fn (#2879) 2024-08-26 13:58:23 -07:00
slots chore: upgrade dependencies (#2765) 2024-08-10 20:01:41 -04:00
spread examples: porting to 0.7 and cleaning up 2024-08-01 19:42:20 -04:00
ssr_modes fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
ssr_modes_axum fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
static_routing feat: add support for static routing and incremental static regeneration (#2875) 2024-08-31 10:33:12 -04:00
stores feat: directly implement IntoIterator on keyed fields 2024-09-14 21:22:16 -04:00
suspense_tests chore: update suspense_test example to use Resource::map (#2877) 2024-09-07 20:56:30 -04:00
tailwind_actix fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
tailwind_axum fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
tailwind_csr chore: upgrade dependencies (#2765) 2024-08-10 20:01:41 -04:00
timer fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
todo_app_sqlite fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
todo_app_sqlite_axum fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
todo_app_sqlite_csr fix: update to wasm-bindgen 0.2.93 (#2827) 2024-08-13 15:21:57 -07:00
todomvc fix: fix web-sys warnings in server_fn (#2828) 2024-08-13 15:46:34 -07:00
Makefile.toml projects: add sitemap demo project (#2553) 2024-05-06 08:46:49 -04:00
README.md feat: allow spreading of both attributes and event handlers (#2432) 2024-04-05 14:30:34 -04:00
SSR_NOTES.md doc(examples): reference run instructions (#1705) 2023-09-13 19:57:50 -04:00

Examples README

Main Branch

The examples in this directory are all built and tested against the current main branch.

To the extent that new features have been released or breaking changes have been made since the previous release, the examples are compatible with the main branch and not the current release.

Getting Started

The simplest way to get started with any example is to use the “quick start” command found in the README for each example. Most of the examples use either trunk (a simple build system and dev server for client-side-rendered apps) or cargo-leptos (a build system for server-rendered and client-hydrated apps).

Using Cargo Make

You can also run any of the examples using cargo-make. Note that this is completely optional. We use it for CI, and it can be convenient for running the examples, but is not required.

Follow these steps to get any example up and running.

  1. cd to the example you want to run
  2. Make sure cargo-make is installed (for example by running cargo install cargo-make)
  3. Make sure rustup target add wasm32-unknown-unknown was executed for the currently selected toolchain.
  4. Run cargo make ci to setup and test the example
  5. Run cargo make start to run the example
  6. Open the client URL in the console output (http://127.0.0.1:8080 or http://127.0.0.1:3000 by default)
  7. Run cargo make stop to end any processes started by cargo make start.

Here are a few additional notes:

  • Extendable custom task files are located in the cargo-make directory
  • Running a task will automatically install cargo dependencies
  • Each Makefile.toml file must extend the cargo-make/main.toml file
  • cargo-make files that end in *-test.toml configure web testing strategies
  • Run cargo make test-report to learn which examples have web tests

Prerequisites

Example projects depend on the following tools. Please install them as needed.

  • Rust
  • Nightly Rust
    • Run rustup toolchain install nightly
    • Run rustup target add wasm32-unknown-unknown
  • Cargo Make
    • Run cargo install --force cargo-make
    • Setup a command alias like alias cm='cargo make' to reduce typing (Optional)
  • Trunk
    • Run cargo install trunk
  • Node Version Manager (Optional)
  • Node.js
  • pnpm (Optional)