Skip to content

hms-dbmi/PIC-SURE-Frontend

Repository files navigation

PIC-SURE Frontend

Tests

NOTE: This project is still under its inital development

Welcome to the PIC-SURE frontend project, a web-based graphical user interface for accessing and querying datasets hosted on the PIC-SURE HPDS (High-performance Data Store) platform.

The PIC-SURE Frontend is designed to provide an intuitive, easy-to-use interface for researchers, enabling them to explore and analyze large-scale biomedical datasets without requiring extensive programming knowledge.

If you are interested in running your own PIC-SURE Platform please check out our All-In-One Project.

If you are looking for some guidance using PIC-SURE, checkout our User Guide.

Contributing & Developing

This project is using SvelteKit! Check out the docs for svelte here and SvelteKit here.

Once you've cloned the project and installed dependencies with npm install (or pnpm install or yarn), start a development server:

npm run dev

# or start the server and open the app in a new browser tab
npm run dev -- --open

You can preview the production build with npm run preview.

To deploy your app, you may need to install an adapter for your target environment.

Testing

If this is the first time testing is run, download new browsers:

npx playwright install

Run unit-tests:

npm run test

Or if you prefer a graphical interface:

npm run playwright

Linting

Before sumbitting please test if there are linting errors that need to be fixed:

  1. Format code using Prettier:
npm run format
  1. Then run eslint:
npm run lint

Building

To create a production version of your app:

npm run build

Contribution

First, please refer to the CONTRIBUTING file for guidelines on how to contribute, submit issues, and propose improvements. Also, please refer to our Code of Conduct.

Configuration

Some PIC-SURE features are configurable. We provide a feature flag file here. This system is under active development and subject to change.

Support

If you are looking for some guidance using PIC-SURE, checkout our User Guide.

Or feel free to start a discussion or reach out via email to: avillach_lab_developers@googlegroups.com

About

A frontend for the PIC-SURE API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published