leptos/examples
Greg Johnston 43421c56d5 example: use a local signal for the input 2024-08-01 19:43:09 -04:00
..
action-form-error-handling Make get_configuration sync (#2647) 2024-08-01 19:42:49 -04:00
cargo-make feat: Add Compression to Hacker News w/ Islands Example (#2613) 2024-06-28 15:01:05 -04:00
counter examples: revert changes to counter 2024-08-01 19:42:50 -04:00
counter_isomorphic feat: allow `!Send` signals 2024-08-01 19:42:51 -04:00
counter_url_query feat: 0.7 query signals 2024-08-01 19:42:21 -04:00
counter_without_macros use `csr` feature so that reactivity runs 2024-08-01 19:41:55 -04:00
counters chore: update test output 2024-08-01 19:42:50 -04:00
directives examples: update directives tests 2024-08-01 19:42:49 -04:00
error_boundary chore: clean up examples for CI 2024-08-01 19:42:21 -04:00
errors_axum Make get_configuration sync (#2647) 2024-08-01 19:42:49 -04:00
fetch examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
gtk refactor insert_before_this to find parent lazily, and use it for rebuilding reactive components by replacing their whole contents 2024-08-01 19:42:21 -04:00
hackernews examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
hackernews_axum examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
hackernews_islands_axum examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
hackernews_js_fetch fix: `hackernews_js_fetch` example for `leptos_0.7` (#2678) 2024-08-01 19:43:09 -04:00
islands Make get_configuration sync (#2647) 2024-08-01 19:42:49 -04:00
islands_router feat: optional branch-marking in HTML to support initial work on client-side islands routing 2024-08-01 19:42:51 -04:00
js-framework-benchmark fix: () in templates 2024-08-01 19:42:21 -04:00
parent_child chore: cargo fmt 2024-08-01 19:41:56 -04:00
portal fix example tests 2024-08-01 19:42:21 -04:00
router example: use `path!` macro in router example 2024-08-01 19:42:51 -04:00
server_fns_axum example: use a local signal for the input 2024-08-01 19:43:09 -04:00
slots chore: clear warning 2024-08-01 19:41:27 -04:00
spread examples: porting to 0.7 and cleaning up 2024-08-01 19:42:20 -04:00
ssr_modes examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
ssr_modes_axum examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
stores chore: clippy 2024-08-01 19:42:50 -04:00
suspense_tests examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
tailwind_actix Make get_configuration sync (#2647) 2024-08-01 19:42:49 -04:00
tailwind_axum Make get_configuration sync (#2647) 2024-08-01 19:42:49 -04:00
tailwind_csr examples: porting to 0.7 and cleaning up 2024-08-01 19:42:20 -04:00
timer examples: timer in 0.7 2024-08-01 19:40:57 -04:00
todo_app_sqlite examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
todo_app_sqlite_axum examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
todo_app_sqlite_csr examples: update to `Suspend::new()` 2024-08-01 19:42:51 -04:00
todomvc examples: porting to 0.7 and cleaning up 2024-08-01 19:42:20 -04: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

README.md

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)