Sfaira portal

Sfaira portal is a website which provides a user interface for searching the content in the Sfaira scRNA-seq data and model zoo. It is available at https://theislab.github.io/sfaira-portal/.

Development

Sfaira portal is a Vue 3 app which uses the Tailwind CSS framework and is built with Vite.

Installation

To setup the project for local development first install Node and NPM https://nodejs.org/en/download/package-manager/.

The project dependencies can then be installed with npm-install:

npm install

Development server

To view the website during development run:

npm run dev

This will launch a local webserver which you can access using the provided URL. It is important to keep an eye on the terminal where you run this command as and messages/warnings/errors produced when building the site will be displayed here.

Building for production

The production output for deployment can be created with:

npm run build

This will create a dist/ folder with the production build website. Deployment of the website is handled by a GitHub actions workflow but it can still sometimes be useful to build it locally for debugging.

Previewing production

Similar to launching the dev server you can preview the production build using:

npm run serve

This will let you view the contents of dist/. The results should be the same as the development server but it's worth checking just in case.

Citation

If you use Sfaira or the Sfaira portal for you work please cite the following publication:

David S. Fischer, Leander Dony, Martin König, Abdul Moeed, Luke Zappia, Lukas Heumos, Sophie Tritschler, Olle Holmberg, Hananeh Aliee, Fabian J. Theis. Sfaira accelerates data and model reuse in single cell genomics. Genome Biology. 2021. DOI: 10.1186/s13059-021-02452-6

@ARTICLE{Fischer2021-xk,
  title    = "Sfaira accelerates data and model reuse in single cell genomics",
  author   = "Fischer, David S and Dony, Leander and K{\"o}nig, Martin and
              Moeed, Abdul and Zappia, Luke and Heumos, Lukas and Tritschler,
              Sophie and Holmberg, Olle and Aliee, Hananeh and Theis, Fabian J",
  journal  = "Genome Biol.",
  volume   =  22,
  number   =  1,
  pages    = "248",
  month    =  aug,
  year     =  2021,
  language = "en"
}