Skip to content

About

Documentation for Codefair.io

Resources

Stars

1 star

Watchers

2 watching

Forks

Repository files navigation

logo

Codefair Documentation

Documentation for the Codefair platform.


contributors stars open issues license



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.

🧰 Developer Instructions

‼️ Prerequisites

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.

🏃 Run Locally

Clone the project

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

Trust and install the required tool versions

mise trust
mise install

Install the dependencies

pnpm install

Start the server

pnpm dev

🏗️ Build Locally

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

pnpm docs:build

▶️ 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 pnpm dev. Make sure to check the console for any errors.
  3. Test your changes on a local build by running pnpm docs:build and pnpm docs:serve. If this works, you can submit your 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.

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



About

Documentation for Codefair.io

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages