Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/broadinstitute/firecloud-ui

FireCloud user interface for web browsers.

https://github.com/broadinstitute/firecloud-ui

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

FireCloud user interface for web browsers.

Basic Info
  • Host: GitHub
  • Owner: broadinstitute
  • License: bsd-3-clause
  • Language: Clojure
  • Default Branch: develop
  • Homepage: https://portal.firecloud.org
  • Size: 6.31 MB
Statistics
  • Stars: 19
  • Watchers: 67
  • Forks: 8
  • Open Issues: 19
  • Releases: 0
Created about 11 years ago · Last pushed over 1 year ago
Metadata Files
Readme Contributing License

README.md

FireCloud UI

FireCloud user interface for web browsers.

https://portal.firecloud.org

Technologies

ClojureScript is used for the UI.

We use the Leiningen build tool to manage ClojureScript dependencies, and npm for Javascript dependencies.

The code incorporates usage of react-cljs which is a ClojureScript wrapper for React.

Figwheel replaces the running JavaScript within the page so changes are visible without a browser reload. More information here. This video gives some insight into the productivity gains available when using this technology (up to about 15:00 is all that is necessary).

Scala and Selenium are used for full-system UI integration tests.

IntelliJ Setup

Choose File -> New -> Project from Existing Sources... and select the base firecloud-uidirectory of your git clone. With the Cursive plugin installed, you can select Import project from external model and then select Leiningen. If prompted for a Project SDK, select a recent Java SDK to use.

Developing

FireCloud is currently supported within Broad's engineering environment:

https://github.com/broadinstitute/terra-helmfile

Support for running FireCloud outside of the Broad is planned.

Styles and Conventions

Before you get started, take a look at CONTRIBUTING.md

Development Stack Setup

  1. Render configuration files by running: ./local-dev/bin/render
  2. Be sure you've added local.broadinstitute.org to your /etc/hosts:

bash sudo sh -c "echo '127.0.0.1 local.broadinstitute.org' >> /etc/hosts"

Starting the development server

bash ./config/docker-rsync-local-ui.sh

You must be viewing the application via HTTP. HTTPS is not supported by Figwheel.

This can take around 40 seconds to completely start. When ready, it will display the following message:

Prompt will show when figwheel connects to your application

To connect, load ~~http://local.broadinstitute.org~~ http://localhost:3449 in your browser (Chrome is strongly recommended for development). The prompt should appear less than ten seconds after you reload the page. If it is not connecting, make sure to check the JavaScript console for error messages.

Building

To compile the clojure project into the target directory, run

bash ./scripts/build.sh compile

To compile and build the broadinstitute/firecloud-ui docker image, run

bash ./scripts/build.sh compile -d build

Testing

See TESTING.md

Owner

  • Name: Broad Institute
  • Login: broadinstitute
  • Kind: organization
  • Location: Cambridge, MA

Broad Institute of MIT and Harvard

GitHub Events

Total
  • Delete event: 6
  • Push event: 1
  • Pull request event: 5
  • Pull request review event: 1
  • Create event: 1
Last Year
  • Delete event: 6
  • Push event: 1
  • Pull request event: 5
  • Pull request review event: 1
  • Create event: 1

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: over 5 years
  • Total issue authors: 0
  • Total pull request authors: 4
  • Average comments per issue: 0
  • Average comments per pull request: 0.4
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: about 2 hours
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • jyang-broad (4)
  • gdlex4015 (2)
  • aednichols (2)
  • ahaessly (1)
  • aweng98 (1)
Top Labels
Issue Labels
Pull Request Labels
Do Not Merge (1)

Dependencies

project.clj clojars
  • dmohs/react 1.3.0
  • inflections 0.13.0
  • org.broadinstitute/react-cljs-modal 2017.08.28
  • org.clojure/clojure 1.9.0
  • org.clojure/clojurescript 1.9.946
package-lock.json npm
  • 442 dependencies
package.json npm
  • ajv ^6.12.6 development
  • copy-webpack-plugin ^5.1.2 development
  • css-loader ^1.0.1 development
  • file-loader ^1.1.6 development
  • git-revision-webpack-plugin ^3.0.6 development
  • sass ^1.32.8 development
  • sass-loader ^7.3.1 development
  • style-loader ^0.19.1 development
  • url-loader ^0.6.2 development
  • webpack ^4.46.0 development
  • webpack-cli ^3.3.12 development
  • any-resize-event ^1.0.0
  • codemirror ^5.60.0
  • create-react-class ^15.7.0
  • font-awesome ^4.7.0
  • foundation-sites ~6.3.1
  • github-markdown-css ^2.10.0
  • jquery ^3.6.0
  • markdown-it ^13.0.1
  • prop-types ^15.7.2
  • react ^16.14.0
  • react-autosuggest ^9.4.3
  • react-dom ^16.14.0
  • react-load-script ^0.0.6
  • select2 ^4.0.13
.github/workflows/trivy.yaml actions
  • actions/checkout v2 composite
  • broadinstitute/dsp-appsec-trivy-action v1 composite
  • github/codeql-action/upload-sarif v1 composite
Dockerfile docker
  • broadinstitute/apache-proxy latest build