https://github.com/fairdataihub/codefair-docs
https://github.com/fairdataihub/codefair-docs
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/fairdataihub/codefair-docs
- Owner: fairdataihub
- License: mit
- Created: 2024-06-18T17:25:45.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-25T16:04:23.000Z (over 1 year ago)
- Last Synced: 2025-03-25T17:22:56.792Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://docs.codefair.io
- Size: 4.94 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
- Codeowners: .github/CODEOWNERS
- Codemeta: codemeta.json
Awesome Lists containing this project
README
Codefair Documentation
Documentation for the Codefair platform.
docs.codefair.io
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.
## :triangular_flag_on_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][cc-by]. See [LICENSE](LICENSE.txt) for more information.
[cc-by]: http://creativecommons.org/licenses/by/4.0/
[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
[![CC BY 4.0][cc-by-image]][cc-by]
## 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.
---
