lewis.moe / leptos-sounds-like-a-disease
Messing around with leptos SSR to see if it's able to work for our use-cases.
fork atom
Rust 52.4%
TypeScript 46.7%
SCSS 0.9%
5 1 0

Clone this repository

https://tangled.org/lewis.moe/leptos-sounds-like-a-disease
git@tangled.org:lewis.moe/leptos-sounds-like-a-disease

For self-hosted knots, clone URLs may differ based on your setup.

Download tar.gz
README.md

Leptos Sounds like a Disease#

Doing dev#

If you don't have cargo-leptos installed you can install it with

cargo install cargo-leptos --locked

Feel free to explore the project structure, but the best place to start with your application code is in src/app.rs.
Addtionally, Cargo.toml may need updating as new versions of the dependencies are released, especially if things are not working after a cargo update.

Then just run the thing in dev mode:

cargo leptos watch

Installing Additional Tools#

By default, cargo-leptos uses nightly Rust, cargo-generate, and sass. If you run into any trouble, you may need to install one or more of these tools.

  1. rustup toolchain install nightly --allow-downgrade - make sure you have Rust nightly
  2. rustup target add wasm32-unknown-unknown - add the ability to compile Rust to WebAssembly
  3. cargo install cargo-generate - install cargo-generate binary (should be installed automatically in future)
  4. npm install -g sass - install dart-sass (should be optional in future
  5. Run npm install in end2end subdirectory before test

Compiling for Release#

cargo leptos build --release

Will generate the server binary in target/server/release and the site package in target/site

Testing the Project#

cargo leptos end-to-end

cargo leptos end-to-end --release

Cargo-leptos uses Playwright as the end-to-end test tool.
Tests are located in end2end/tests directory.

Executing a Server on a Remote Machine Without the Toolchain#

After running a cargo leptos build --release the minimum files needed are:

  1. The server binary located in target/server/release
  2. The site directory and all files within located in target/site

Copy these files to your remote server. The directory structure should be:

leptos-sounds-like-a-disease
site/

Set the following environment variables (updating for your project as needed):

export LEPTOS_OUTPUT_NAME="leptos-sounds-like-a-disease"
export LEPTOS_SITE_ROOT="site"
export LEPTOS_SITE_PKG_DIR="pkg"
export LEPTOS_SITE_ADDR="127.0.0.1:3000"
export LEPTOS_RELOAD_PORT="3001"

Finally, run the server binary.