Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/broadinstitute/data-registry

https://github.com/broadinstitute/data-registry

Science Score: 36.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
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ✓
    Committers with academic emails
    3 of 6 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.6%) to scientific vocabulary

Keywords from Contributors

projection interactive archival generic sequences observability autograding hacking shellcodes modular
Last synced: 10 months ago · JSON representation

Repository

Basic Info
  • Host: GitHub
  • Owner: broadinstitute
  • License: bsd-3-clause
  • Language: Vue
  • Default Branch: main
  • Size: 17.2 MB
Statistics
  • Stars: 0
  • Watchers: 7
  • Forks: 1
  • Open Issues: 10
  • Releases: 0
Created over 3 years ago · Last pushed 11 months ago
Metadata Files
Readme License

README.md

Data Registry Front End

This is a Nuxt application, which is a structured way to do Vue development. Look at the Nuxt 3 documentation to learn more. We use pinia in some places for state management, see pinia docs and within this project see DatasetStore.js.

Setup

Make sure to install the dependencies:

bash npm install

Development Server

We use a cookie for authentication so you need to use the same domain for the front end and the API. The easiest way to do this is to add an entry in your /etc/hosts file like this: 127.0.0.1 local.kpndataregistry.org If you're running the API server locally and want to access it from your local front end dev server, in your .env file set NUXT_PUBLIC_API_BASE_URL=http://local.kpndatregistry.org:5000 as an example.

If you're only making front end changes and want to use the qa deployed api server, in your .env set NUXT_PUBLIC_API_BASE_URL=https://api.kpndataregistry.org but you'll need to use https when serving this project because QA is https and browsers don't allow you to mix http and https communications.
You can set up https proxy back to you dev server by using this docker file. Build and start that container and then start your dev server as per the instructions below and you'll be able to access the front end at https://local.kpndataregistry.org:8000.

To start the development server:

bash npm run dev-auth # with authentication (you'll need to point to an API server and use *.kpndataregistry.org host name) npm run dev # without authentication (you can just localhost)

Deployment

Deploy to QA occurs automatically upon push to the main branch via github actions. You can deploy to Production by pushing a semantic version tag to the repo. The tag should be of the form V#.#.#, and ideally the tag should point to a commit on the main branch. You can use the next_release.py script to determine what the next tag should be. python next_release.py and choose your release type (major, minor, or patch) at the prompt. You can read more about creating and publishing tags here.

Sample .env

A sample .env file is provided, .env-sample. It should be copied to the root directory and renamed to .env. The following environment variables are required:

NUXT_PUBLIC_API_SECRET=?? NUXT_PUBLIC_API_BASE_URL=?? NUXT_PUBLIC_PHENOTYPES_URL=??

Owner

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

Broad Institute of MIT and Harvard

GitHub Events

Total
  • Delete event: 9
  • Issue comment event: 5
  • Push event: 46
  • Pull request event: 24
  • Create event: 23
Last Year
  • Delete event: 9
  • Issue comment event: 5
  • Push event: 46
  • Pull request event: 24
  • Create event: 23

Committers

Last synced: about 1 year ago

All Time
  • Total Commits: 492
  • Total Committers: 6
  • Avg Commits per committer: 82.0
  • Development Distribution Score (DDS): 0.516
Past Year
  • Commits: 73
  • Committers: 2
  • Avg Commits per committer: 36.5
  • Development Distribution Score (DDS): 0.123
Top Committers
Name Email Commits
Annie Moriondo a****d@b****g 238
Drew Hite d****w@d****g 190
Quy q****y@b****v 49
dependabot[bot] 4****] 10
Annie Moriondo a****d@w****g 3
dkjang d****g@b****g 2
Committer Domains (Top 20 + Academic)
broadinstitute.org: 2 wm790-4ff.broadinstitute.org: 1 broad.dev: 1 drewhite.org: 1

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 2
  • Total pull requests: 155
  • Average time to close issues: 3 months
  • Average time to close pull requests: 10 days
  • Total issue authors: 1
  • Total pull request authors: 5
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.51
  • Merged pull requests: 79
  • Bot issues: 0
  • Bot pull requests: 73
Past Year
  • Issues: 0
  • Pull requests: 5
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • qu-y (2)
Pull Request Authors
  • dependabot[bot] (87)
  • sagehen03 (44)
  • moriondo2022 (18)
  • nicksunderland (6)
  • qu-y (5)
Top Labels
Issue Labels
bug (2)
Pull Request Labels
dependencies (87) enhancement (1)

Dependencies

.github/workflows/continuous-integration.yml actions
  • actions/checkout v4 composite
  • actions/download-artifact v4 composite
  • actions/setup-node v4 composite
  • actions/upload-artifact v4 composite
  • appleboy/scp-action master composite
Dockerfile docker
  • nginx latest build
backend/Dockerfile docker
  • python 3.9-slim build
backend/docker-compose.yml docker
  • mysql 8.0.32
package-lock.json npm
  • 1325 dependencies
package.json npm
  • @nuxt/devtools 1.2.0 development
  • @nuxt/eslint-config 0.3.9 development
  • @nuxt/test-utils 3.12.1 development
  • @nuxtjs/eslint-config 12.0.0 development
  • @nuxtjs/tailwindcss 6.12.0 development
  • @stylistic/eslint-plugin-js 1.7.2 development
  • @vitejs/plugin-vue 5.0.4 development
  • @vue/test-utils 2.4.5 development
  • cypress ^13.9.0 development
  • cypress-file-upload ^5.0.8 development
  • eslint 8.57.0 development
  • eslint-config-standard 17.1.0 development
  • eslint-plugin-import 2.29.1 development
  • eslint-plugin-n ^16.6.2 development
  • eslint-plugin-promise 6.1.1 development
  • eslint-plugin-vue 9.25.0 development
  • nuxt 3.11.2 development
  • nuxt-primevue ^0.3.1 development
  • nuxt-shiki ^0.3.0 development
  • playwright-core 1.43.1 development
  • sass 1.75.0 development
  • sass-loader 14.2.1 development
  • start-server-and-test ^2.0.3 development
  • vite 5.2.10 development
  • vitest 1.5.1 development
  • vue-router 4.3.2 development
  • @pinia/nuxt 0.5.1
  • axios 1.6.8
  • bootstrap 5.3.3
  • bootstrap-icons 1.11.3
  • chart.js 4.4.2
  • d3 7.9.0
  • primeflex 3.3.1
  • primeicons 7.0.0
  • primevue 3.51.0