distribution-calc/README.md

33 lines
879 B
Markdown

# hypergeometric-calc
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.
## 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