diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 81 |
1 files changed, 0 insertions, 81 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index adb94ce..0000000 --- a/README.md +++ /dev/null @@ -1,81 +0,0 @@ -<picture> - <source srcset="https://raw.githubusercontent.com/leptos-rs/leptos/main/docs/logos/Leptos_logo_Solid_White.svg" media="(prefers-color-scheme: dark)"> - <img src="https://raw.githubusercontent.com/leptos-rs/leptos/main/docs/logos/Leptos_logo_RGB.svg" alt="Leptos Logo"> -</picture> - -# Leptos Client-Side Rendered (CSR) App Starter Template - -This is a template for use with the [Leptos] web framework using the [Trunk] -tool to compile and serve your app in development. - -## Creating your repo from the template - -This template requires you to have `cargo-generate` and `trunk` installed. -[`leptosfmt`](https://github.com/bram209/leptosfmt) is optional but highly -recommended. You can install them with - -```sh -cargo install cargo-generate trunk leptosfmt -``` - -To set up your project with this template, run - -```sh -cargo generate --git https://github.com/leptos-rs/start-trunk -``` - -to generate your new project, then - -```sh -cd {{project-name}} -``` - -to go to your newly created project. - -By default, this template uses Rust `nightly` and requires that you've installed -the `wasm` compilation target for your toolchain. - -Sass and Tailwind are also supported by the Trunk build tool, but are optional -additions: [see here for more info on how to set those up with -Trunk][trunk-instructions]. - -If you don't have Rust nightly, you can install it with - -```sh -rustup toolchain install nightly --allow-downgrade -``` - -You can add the `wasm` compilation target to rust using - -```sh -rustup target add wasm32-unknown-unknown -``` - -## Developing your Leptos CSR project - -To develop your Leptos CSR project, running - -```sh -trunk serve --port 3000 --open -``` - -will open your app in your default browser at `http://localhost:3000`. - -## Deploying your Leptos CSR project - -To build a Leptos CSR app for release, use the command - -```sh -trunk build --release -``` - -This will output the files necessary to run your app into the `dist` folder; you -can then use any static site host to serve these files. - -For further information about hosting Leptos CSR apps, please refer to [the -Leptos Book chapter on deployment available here][deploy-csr]. - -[deploy-csr]: https://book.leptos.dev/deployment/csr.html -[leptos]: https://github.com/leptos-rs/leptos -[trunk]: https://github.com/trunk-rs/trunk -[trunk-instructions]: https://trunkrs.dev/assets/ |