Data

Tools

Indexes

Applications

Experiments

Open Source Science

codefair-docs

https://github.com/fairdataihub/codefair-docs

Science Score: 44.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
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.5%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: fairdataihub
  • License: mit
  • Language: JavaScript
  • Default Branch: main
  • Homepage: https://docs.codefair.io
  • Size: 5.28 MB
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 12
  • Releases: 0
Created over 1 year ago · Last pushed 6 months ago
Metadata Files
Readme License Citation Codeowners Codemeta

README.md

logo

Codefair Documentation

Documentation for the Codefair platform.

docs.codefair.io


contributors stars open issues license

Report Issues/Make suggestions


About

Codefair is a platform for that combines the power of GitHub apps and an intuitive UI to help making research software reusable and complying with the FAIR principles for Research Software (FAIR4RS Principles). This repository contains the developer and user documentation for the Codefair platform.

:toolbox: Developer Instructions

:bangbang: Prerequisites

This project uses yarn as the package manager. If you do not have yarn installed, you can install it with the following command:

bash npm install -g yarn

If you already have a conda environment on your machine, you can install the dependencies with:

bash conda install -c conda-forge yarn nodejs

:running: Run Locally

Clone the project

bash git clone https://github.com/fairdataihub/codefair-docs.git

Install the dependencies

bash yarn install

Start the server

bash yarn dev

:building_construction: Build Locally

Use this to build a local production version of the site. User docs:serve to preview the local build.

bash yarn docs:build

:arrow_forward: Submitting a PR

If you are an external contributor, please make a fork of the repository and submit a PR from your fork.

  1. Create a new branch from the main branch.
  2. Make your changes. You can test your changes locally by running yarn dev. Make sure to check the console for any errors.
  3. Test your changes on a local build by running yarn build and yarn serve. If this works, you can submit yout changes.
  4. Push your changes to the remote branch.
  5. Create a PR to merge your branch into main.

You can tag @slugb0t or @megasanjay in the PR on GitHub for a review. If your changes are approved, they will be merged into main and deployed to the live site.

: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.

Contributing

License

This work is licensed under a Creative Commons Attribution 4.0 International License. See LICENSE for more information.

CC BY 4.0

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.


logo

Owner

  • Name: FAIR Data Innovations Hub
  • Login: fairdataihub
  • Kind: organization
  • Email: info@fairdataihub.org
  • Location: United States of America

We build open source tools to help researchers learn about and implement FAIR Data practices

Citation (CITATION.cff) 

title: codefair-docs
authors:
  - given-names: Dorian
    family-names: Portillo
    email: wheresdorian@gmail.com
    affiliation: FAIR Data Innovations Hub
  - given-names: Bhavesh
    family-names: Patel
    affiliation: California Medical Innovations Institute
cff-version: 1.2.0
message: If you use this software, please cite it using the metadata from this file.
type: software
abstract: Documentation for Codefair (codefair.io)
keywords:
  - documentation
  - codefair
  - FAIR software
  - FAIR-BioRS
license: MIT
repository-code: https://github.com/fairdataihub/codefair-docs

CodeMeta (codemeta.json) 

{
  "name": "codefair-docs",
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "author": [
    {
      "affiliation": {
        "name": "FAIR Data Innovations Hub",
        "type": "Organization"
      },
      "email": "wheresdorian@gmail.com",
      "familyName": "Portillo",
      "id": "_:author_1",
      "givenName": "Dorian",
      "type": "Person"
    },
    {
      "affiliation": {
        "name": "California Medical Innovations Institute",
        "type": "Organization"
      },
      "familyName": "Patel",
      "id": "_:author_2",
      "givenName": "Bhavesh",
      "type": "Person"
    }
  ],
  "codeRepository": "https://github.com/fairdataihub/codefair-docs",
  "dateCreated": "2024-06-18",
  "description": "Documentation for Codefair (codefair.io)",
  "issueTracker": "https://github.com/fairdataihub/codefair-docs/issues",
  "keywords": [
    "documentation",
    "codefair",
    "FAIR software",
    "FAIR-BioRS"
  ],
  "license": "https://spdx.org/licenses/MIT",
  "operatingSystem": [],
  "programmingLanguage": [
    "JavaScript"
  ],
  "relatedLink": [],
  "runtimePlatform": [],
  "softwareRequirements": [],
  "type": "SoftwareSourceCode"
}

GitHub Events

Total
  • Delete event: 3
  • Issue comment event: 21
  • Push event: 69
  • Pull request review event: 6
  • Pull request review comment event: 9
  • Pull request event: 12
  • Create event: 4
Last Year
  • Delete event: 3
  • Issue comment event: 21
  • Push event: 69
  • Pull request review event: 6
  • Pull request review comment event: 9
  • Pull request event: 12
  • Create event: 4

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 5
  • Total pull requests: 20
  • Average time to close issues: 20 days
  • Average time to close pull requests: 8 days
  • Total issue authors: 2
  • Total pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 2.35
  • Merged pull requests: 9
  • Bot issues: 5
  • Bot pull requests: 13
Past Year
  • Issues: 5
  • Pull requests: 20
  • Average time to close issues: 20 days
  • Average time to close pull requests: 8 days
  • Issue authors: 2
  • Pull request authors: 4
  • Average comments per issue: 0.0
  • Average comments per pull request: 2.35
  • Merged pull requests: 9
  • Bot issues: 5
  • Bot pull requests: 13
View more stats
Top Authors
Issue Authors
  • codefair-app[bot] (4)
  • renovate[bot] (1)
Pull Request Authors
  • renovate[bot] (22)
  • slugb0t (8)
  • bvhpatel (6)
  • codefair-io[bot] (1)
  • codefair-app[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
type: dependencies (22)