diff --git a/examples/todo_app_sqlite/README.md b/examples/todo_app_sqlite/README.md index 9a6ad39c0..53772837b 100644 --- a/examples/todo_app_sqlite/README.md +++ b/examples/todo_app_sqlite/README.md @@ -1,19 +1,23 @@ -# Leptos Todo App Sqlite +# Leptos Todo App Sqlite This example creates a basic todo app with an Actix backend that uses Leptos' server functions to call sqlx from the client and seamlessly run it on the server. ## Client Side Rendering -To run it as a Client Side App, you can issue `trunk serve --open` in the root. This will build the entire -app into one CSR bundle. Make sure you have trunk installed with `cargo install trunk`. + +This example cannot be built as a trunk standalone CSR-only app. Only the server may directly connect to the database. ## Server Side Rendering with cargo-leptos + cargo-leptos is now the easiest and most featureful way to build server side rendered apps with hydration. It provides automatic recompilation of client and server code, wasm optimisation, CSS minification, and more! Check out more about it [here](https://github.com/akesson/cargo-leptos) 1. Install cargo-leptos + ```bash cargo install --locked cargo-leptos -``` +``` + 2. Build the site in watch mode, recompiling on file changes + ```bash cargo leptos watch ``` @@ -21,24 +25,30 @@ cargo leptos watch Open browser on [http://localhost:3000/](http://localhost:3000/) 3. When ready to deploy, run + ```bash cargo leptos build --release ``` ## Server Side Rendering without cargo-leptos + To run it as a server side app with hydration, you'll need to have wasm-pack installed. 0. Edit the `[package.metadata.leptos]` section and set `site-root` to `"."`. You'll also want to change the path of the `` component in the root component to point towards the CSS file in the root. This tells leptos that the WASM/JS files generated by wasm-pack are available at `./pkg` and that the CSS files are no longer processed by cargo-leptos. Building to alternative folders is not supported at this time. You'll also want to edit the call to `get_configuration()` to pass in `Some(Cargo.toml)`, so that Leptos will read the settings instead of cargo-leptos. If you do so, your file/folder names cannot include dashes. 1. Install wasm-pack + ```bash cargo install wasm-pack ``` + 2. Build the Webassembly used to hydrate the HTML from the server + ```bash wasm-pack build --target=web --debug --no-default-features --features=hydrate ``` -3. Run the server to serve the Webassembly, JS, and HTML + +3. Run the server to serve the Webassembly, JS, and HTML + ```bash cargo run --no-default-features --features=ssr ``` -