distribution-calc/README.md

39 lines
1 KiB
Markdown
Raw Normal View History

2025-03-14 21:02:08 +00:00
# hypergeometric-calc
2025-03-14 17:48:32 -03:00
Web calculator for Hypergeometric Distribution built using [Leptos].
## Dependencies
You will need to install the Rust toolchain. We recommend to do using [Rustup]. Once
you do that, we will need to install the WASM target
```sh
rustup target add wasm32-unknown-unknown
```
We will also use the [Trunk] tool to run and build our project.
Finally, it's recommended to install the `leptosfmt` tool, since plain `rustfmt`
can't dealt with `view!` macros very well.
```sh
cargo install leptosfmt
```
2025-03-14 17:48:32 -03:00
## Developing
To develop the project, run
```sh
trunk serve --port 3000 --open
```
which, will open the app in your default browser at `http://localhost:3000`.
## Deploying
To build the project 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.
[Leptos]: https://github.com/leptos-rs/leptos
[Rustup]: https://rustup.rs/
[Trunk]: https://github.com/trunk-rs/trunk
2025-03-14 21:02:08 +00:00