Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,6 @@ The workflow runs as so:
through the top-level [`run_snakemake.sh`](./run_snakemake.sh) shell script.
1. Run each config YAML file in `configs/` with SPRAS.
1. Build the website in `web` with the generated `output` from all of the SPRAS runs, and deploy it on [GitHub Pages](https://pages.github.com/).
To see how to build the website, go to its [README](./web/README.md).

For more information on how to add a dataset, see [CONTRIBUTING.md](./CONTRIBUTING.md).
22 changes: 22 additions & 0 deletions web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,25 @@

This module is an [Astro](https://astro.build/) project which wraps the output from SPRAS
into a presentable webpage. See the output: https://reed-compbio.github.io/spras-benchmarking/

## Building

To build this, you need [`pnpm`](https://pnpm.io/). It is recommended to use a node version manager
([nvm](https://github.com/nvm-sh/nvm) for mac/linux, [nvm-windows](https://github.com/coreybutler/nvm-windows) for windows),
to install `nodejs` and `npm` (at the time of writing, this would be node `v22`), and use `npm` to install `pnpm`:

```sh
npm install --global pnpm
```

After this, you can install the dependencies (make sure your current working directory is `web`):

```sh
pnpm install
```

Then, assuming your data is in `public/data`, build the website:

```sh
pnpm run build
```
Loading