dev.aireadi.org
Software development best practices of the AI-READI project
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 (15.1%) to scientific vocabulary
Repository
Software development best practices of the AI-READI project
Basic Info
- Host: GitHub
- Owner: AI-READI
- License: mit
- Language: JavaScript
- Default Branch: main
- Homepage: https://dev.aireadi.org
- Size: 251 KB
Statistics
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
dev.aireadi.org
Software development best practices for the AI-READI project
Sublink 1 · Documentation · Changelog · Report Bug · Request Feature
Description
This documentation is a central repository for storing developer information on the fairhub.io project. It is intended to be used by the developer team for getting instructions on running, building, and releasing our projects.
Getting started
For instructions on how to install and build these docs, see the README file.
⚠️ Prerequisites
This project uses Yarn as package manager.
sh
npm install --global yarn
If you already have a Anaconda environment on your machine, you can install the dependencies with:
sh
conda install -c conda-forge yarn nodejs
Run locally
Clone the project
sh
https://github.com/AI-READI/dev.aireadi.org.git
Go to the project directory
sh
cd dev.aireadi.org
Install dependencies
sh
yarn install
Start the server
sh
yarn dev
Build locally
Use this step to build a local production version of the site. Use docs:serve to preview the local build.
sh
yarn docs:build
yarn docs:serve
Deployment
This repository is automatically deployed to Azure on every push to the repository. If you need to reference a specific branch or pull request, you can do so by using the following URL pattern:
- https://wonderful-tree-09f1c2410-
.centralus.2.azurestaticapps.net/ - https://wonderful-tree-09f1c2410-
.centralus.2.azurestaticapps.net/
The production branch is automatically deployed to the following URL: https://dev.aireadi.org
Contributing
Contributions are always welcome!
If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.
For any developmental standards to follow, add them directly to the CONTRIBUTING.md file.
Issues and Feedback
To report any issues with the software, suggest improvements, or request a new feature, please open a new issue via the Issues tab. Provide adequate information (operating system, steps leading to error, screenshots) so we can help you efficiently.
License
This work is licensed under MIT. See LICENSE for more information.
How to cite
If you are using this software or reusing the source code from this repository for any purpose, please cite:
bash
ADD Citation here
Acknowledgements
This project is funded by the NIH under award number 1OT2OD032644. The content is solely the responsibility of the authors and does not necessarily represent the official views of the NIH.
Add any other acknowledgements here.
Owner
- Name: AI-READI
- Login: AI-READI
- Kind: organization
- Location: United States of America
- Repositories: 22
- Profile: https://github.com/AI-READI
Organization of the AI-READI data generation project of the NIH-funded Bridge2AI Program
Citation (CITATION.cff)
abstract: Development documentation for the fairhub.io project
authors:
- affiliation: FAIR Data Innovations Hub
email: ssoundarajan@calmi2.org
family-names: Soundarajan
given-names: Sanjay
- affiliation: FAIR Data Innovations Hub
email: bpatel@calmi2.org
family-names: Patel
given-names: Bhavesh
cff-version: 1.2.0
date-released: '2022-11-29'
identifiers:
- description: DOI for this software's record on Zenodo
type: doi
value: https://doi.org/10.5281/zenodo.7373697
keywords:
- AI-READI
- fairhub
- project
license: MIT
message: If you use this software, please cite it as below.
repository-artifact: https://github.com/AI-READI/dev.fairhub.io
repository-code: https://github.com/AI-READI/dev.fairhub.io
title: dev.fairhub.io
type: software
url: https://dev.fairhub.io/
version: 0.0.1
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/AI-READI/dev.fairhub.io",
"dateCreated": "2022-11-29",
"dateModified": "2022-11-29",
"downloadUrl": "https://github.com/AI-READI/dev.fairhub.io",
"issueTracker": "https://github.com/AI-READI/dev.fairhub.io/issues",
"name": "dev.fairhub.io",
"version": "0.0.1",
"identifier": "https://doi.org/10.5281/zenodo.7373697",
"description": "Development documentation for the fairhub.io project",
"applicationCategory": "Scientific",
"funding": "1OT2OD032644",
"developmentStatus": "active",
"isPartOf": "https://aireadi.org/",
"funder": {
"@type": "Organization",
"@name": "National Institutes of Health (NIH)"
},
"keywords": [
"AI-READI",
"fairhub",
"project"
],
"programmingLanguage": [
"JavaScript",
"CSS"
],
"relatedLink": [
"https://dev.fairhub.io/",
"https://github.com/AI-READI"
],
"author": [
{
"@type": "Person",
"givenName": "Sanjay",
"familyName": "Soundarajan",
"email": "ssoundarajan@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
Last Year
Dependencies
- @commitlint/cli 17.2.0 development
- @commitlint/config-conventional 17.2.0 development
- @fairdataihub/config 2.2.1 development
- @semantic-release/changelog 6.0.1 development
- @semantic-release/commit-analyzer 9.0.2 development
- @semantic-release/git 10.0.1 development
- @semantic-release/github 8.0.6 development
- @semantic-release/npm 9.0.1 development
- @semantic-release/release-notes-generator 10.0.3 development
- devmoji 2.3.0 development
- husky 8.0.1 development
- lint-staged 13.0.3 development
- prettier 2.7.1 development
- semantic-release 19.0.5 development
- vitepress 1.0.0-alpha.27 development
- vue 3.2.41 development
- mermaid ^9.1.3
- vitepress-plugin-mermaid ^2.0.0
- 735 dependencies
- Azure/static-web-apps-deploy v1 composite
- actions/checkout v2 composite
- actions/checkout v3 composite
- peter-evans/create-pull-request main composite
- sobolevn/misspell-fixer-action master composite
- actions/checkout v3 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
- actions/first-interaction v1 composite
- actions/checkout v3 composite
- actions/setup-node v3 composite
- wearerequired/lint-action v2 composite
- actions/checkout v3 composite
- actions/setup-node v3 composite