fair-biors-docs
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.7%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: fairdataihub
- License: mit
- Language: JavaScript
- Default Branch: main
- Homepage: https://fair-biors-docs.vercel.app
- Size: 574 KB
Statistics
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 12
- Releases: 0
Metadata Files
README.md
FAIR BioRS Documentation
A comprehensive documentation of the FAIR BioRS Principles!
What is FAIR BioRS? · Documentation · Changelog · Report Bug · Request Feature
:notebookwithdecorative_cover: Table of Contents
:star2: About the Documentation
:space_invader: Tech Stack
Client
Server
:art: Color Reference
| Color | Hex |
| --------------- | ---------------------------------------------------------------- |
| Primary Color | #13716D |
| Secondary Color |
#BA0D49 |
| Accent Color |
#6B7280 |
| Text Color |
#1C1E21 |
:key: Environment Variables
To run this project, you will need to add the following environment variables to your .env.local file
- None at the moment
:toolbox: Getting Started
:bangbang: Prerequisites
This project uses Yarn as package manager
bash
npm install --global yarn
Additionally, a version of Node.js that is >= 14 is required for compatibility with Docusarus. If your Node.js version is < 14 you can download the latest Node.js version from the Node.js download page.
:running: Run Locally
Clone the project
bash
git clone https://github.com/fairdataihub/FAIR-BioRS-Docs.git
Go to the project directory
bash
cd FAIR-BioRS-Docs
Install dependencies
bash
yarn install
Start the server
bash
yarn start
:stopwatch: Versioning
You can use the version script to create a new documentation version based on the latest content in the docs directory. That specific set of documentation will then be preserved and accessible even as the documentation in the docs directory changes moving forward.
Ideally, you should create a new branch and update the relevant pages. Then send a PR with @megasanjay or @slugb0t on the review page.
Only do these steps after all changes to the documentation for the specific version have been completed:
- Update the docs changelog to be on parity with the changelog in @FAIR-BioRS
- Make sure the current docs version (the
docsdirectory) is ready to be frozen. - Update the
versionkey in package.json for this repository.
bash
yarn run docusaurus docs:version 5.3.0
This will freeze the current version of the documentation. The files under the current docs directory will be considered to be Upcoming 🚧 version.
:building_construction: Build locally
Use this step to build a local production version of the site. Use serve to preview the local build.
bash
yarn build
yarn serve
:triangularflagon_post: Deployment
You will not need to do anything to the hosted site. Continuous Delivery has been setup with Vercel. All you need to do is push your commit and wait for it to deploy.
:wave: Contributing
Contributions are always welcome!
See contributing.md for ways to get started.
:scroll: Code of Conduct
Please read the Code of Conduct
:grey_question: FAQ
Can I make changes to previous versions of the documentation?
- Yes, you can make changes to previous versions of the documentation. You can do this by creating a new branch and adding your changes directly in the
versioned_docsdirectory.
- Yes, you can make changes to previous versions of the documentation. You can do this by creating a new branch and adding your changes directly in the
:warning: License
Distributed under the MIT License. See LICENSE for more information.
:handshake: Contact
Contact us on Twitter: @fairdataihub
Send us an E-mail: info@fairdataihub.org
:gem: Acknowledgements
A special thank you to Vercel for hosting our application documentation.
Owner
- Name: FAIR Data Innovations Hub
- Login: fairdataihub
- Kind: organization
- Email: info@fairdataihub.org
- Location: United States of America
- Website: https://fairdataihub.org
- Repositories: 40
- Profile: https://github.com/fairdataihub
We build open source tools to help researchers learn about and implement FAIR Data practices
Citation (CITATION.cff)
abstract: Documentation for the SODA for SPARC application
authors:
- affiliation: FAIR Data Innovations Hub
email: ssoundarajan@calmi2.org
family-names: Soundarajan
given-names: Sanjay
- affiliation: FAIR Data Innovations Hub
email: dportiollo@calmi2.org
family-names: Portillo
given-names: Dorian
- affiliation: FAIR Data Innovations Hub
email: bpatel@calmi2.org
family-names: Patel
given-names: Bhavesh
cff-version: 1.2.0
date-released: '2023-10-01'
identifiers:
- description: DOI for this software's record on Zenodo
type: doi
value: https://doi.org/10.5281/zenodo.8397262
keywords:
- SPARC
- FAIR
- data
- curation
- documentation
- macos
- sparc-dataset
- ubuntu
- windows
license: MIT
message: If you use this software, please cite it as below.
repository-artifact: https://github.com/fairdataihub/FAIR-BioRS-Docs
repository-code: https://github.com/fairdataihub/FAIR-BioRS-Docs
title: FAIR BioRS docs
type: software
url: https://fairdataihub.org/
version: 26.1.2
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"license": "https://spdx.org/licenses/MIT",
"codeRepository": "https://github.com/fairdataihub/SODA-for-SPARC-Docs",
"dateCreated": "2022-04-01",
"dateModified": "2023-10-01",
"downloadUrl": "https://github.com/fairdataihub/SODA-for-SPARC-Docs",
"issueTracker": "https://github.com/fairdataihub/SODA-for-SPARC-Docs/issues",
"name": "SODA for SPARC docs",
"version": "26.1.2",
"identifier": "https://doi.org/10.5281/zenodo.8397262",
"description": "Documentation for the SODA for SPARC application",
"applicationCategory": "Scientific",
"funding": "OT2OD030213",
"developmentStatus": "active",
"isPartOf": "https://fairdataihub.org/",
"referencePublication": "https://doi.org/10.1096/fasebj.2020.34.s1.02483",
"funder": {
"@type": "Organization",
"@name": "National Institutes of Health (NIH)"
},
"keywords": [
"SPARC",
"FAIR",
"data",
"curation",
"documentation",
"macos",
"sparc-dataset",
"ubuntu",
"windows"
],
"programmingLanguage": [
"JavaScript",
"CSS"
],
"relatedLink": [
"https://docs.sodaforsparc.io/",
"https://github.com/fairdataihub/FAIR-BioRS-Docs"
],
"author": [
{
"@type": "Person",
"givenName": "Sanjay",
"familyName": "Soundarajan",
"email": "ssoundarajan@calmi2.org",
"affiliation": {
"@type": "Organization",
"name": "FAIR Data Innovations Hub"
}
},
{
"@type": "Person",
"givenName": "Dorian",
"familyName": "Portillo",
"email": "dportiollo@calmi2.org",
"affiliation": {
"@type": "Organization",
"name": "FAIR Data Innovations Hub"
}
},
{
"@type": "Person",
"givenName": "Bhavesh",
"familyName": "Patel",
"email": "bpatel@calmi2.org",
"affiliation": {
"@type": "Organization",
"name": "FAIR Data Innovations Hub"
}
}
]
}
GitHub Events
Total
- Delete event: 2
- Issue comment event: 2
- Push event: 46
- Pull request review event: 1
- Pull request event: 4
- Create event: 2
Last Year
- Delete event: 2
- Issue comment event: 2
- Push event: 46
- Pull request review event: 1
- Pull request event: 4
- Create event: 2
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 2
- Total pull requests: 17
- Average time to close issues: N/A
- Average time to close pull requests: 11 months
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.53
- Merged pull requests: 0
- Bot issues: 2
- Bot pull requests: 17
Past Year
- Issues: 0
- Pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.33
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 3
Top Authors
Issue Authors
- doi-checker-app[bot] (1)
- renovate[bot] (1)
Pull Request Authors
- renovate[bot] (21)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v4 composite
- peter-evans/create-pull-request main composite
- sobolevn/misspell-fixer-action master composite
- actions/checkout v4 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
- actions/checkout v4 composite
- webiny/action-conventional-commits v1.1.0 composite
- actions/checkout v4 composite
- wangchucheng/git-repo-sync v0.1.0 composite
- actions/checkout v4 composite
- actions/setup-node v3 composite
- wearerequired/lint-action v2 composite
- actions/setup-node v3 composite
- megasanjay/upload-to-zenodo v2.0.1 composite
- actions/checkout v4 composite
- actions/setup-node v3 composite
- actions/stale v8 composite
- @babel/eslint-parser 7.22.15 development
- @commitlint/cli 17.8.0 development
- @commitlint/config-conventional 17.8.0 development
- @fairdataihub/config 2.2.3 development
- @semantic-release/changelog 6.0.3 development
- @semantic-release/commit-analyzer 11.0.0 development
- @semantic-release/git 10.0.1 development
- @semantic-release/github 9.2.1 development
- @semantic-release/npm 11.0.0 development
- @semantic-release/release-notes-generator 12.0.0 development
- autoprefixer 10.4.11 development
- eslint 8.51.0 development
- eslint-config-airbnb 19.0.4 development
- eslint-config-prettier 9.0.0 development
- eslint-plugin-import 2.28.1 development
- eslint-plugin-jsx-a11y 6.7.1 development
- eslint-plugin-react 7.33.2 development
- husky 8.0.3 development
- lint-staged 14.0.1 development
- megasanjay-devmoji ^1.2.1 development
- postcss 8.4.31 development
- prettier 3.0.3 development
- prettier-plugin-tailwindcss 0.5.6 development
- pretty-quick 3.1.3 development
- run-script-os ^1.1.6 development
- semantic-release 22.0.5 development
- tailwindcss 3.1.8 development
- @docusaurus/core 2.4.3
- @docusaurus/preset-classic 2.4.3
- @emotion/react 11.11.1
- @emotion/styled 11.11.0
- @iconify/react 4.1.1
- @mdx-js/react 1.6.22
- @mui/material 5.11.1
- @notionhq/client 2.2.13
- @svgr/webpack 8.1.0
- axios 1.5.1
- clsx 2.0.0
- docusaurus-plugin-umami ^2.0.0
- docusaurus-theme-frontmatter ^1.3.0
- express 4.18.2
- file-loader 6.2.0
- prism-react-renderer 2.1.0
- prop-types 15.8.1
- react 18.2.0
- react-cookie 5.0.0
- react-dom 18.2.0
- react-lottie 1.2.3
- react-player 2.13.0
- url-loader 4.1.1
- uuid 9.0.1
- 2028 dependencies