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.
This project uses mise to manage the Node.js and pnpm versions, which are pinned in mise.toml. Install mise by following the getting started guide for your platform.
Clone the project
git clone https://github.com/fairdataihub/codefair-docs.git
cd codefair-docsTrust and install the required tool versions
mise trust
mise installInstall the dependencies
pnpm installStart the server
pnpm devUse this to build a local production version of the site. Use docs:serve to preview the local build.
pnpm docs:buildIf you are an external contributor, please make a fork of the repository and submit a PR from your fork.
- Create a new branch from the
mainbranch. - Make your changes. You can test your changes locally by running
pnpm dev. Make sure to check the console for any errors. - Test your changes on a local build by running
pnpm docs:buildandpnpm docs:serve. If this works, you can submit your changes. - Push your changes to the remote branch.
- 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.
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.
This work is licensed under a Creative Commons Attribution 4.0 International License. See LICENSE for more information.
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.

