{"id":23053135,"url":"https://github.com/fairdataihub/codefair-docs","last_synced_at":"2025-04-03T04:23:25.607Z","repository":{"id":245031941,"uuid":"816936964","full_name":"fairdataihub/codefair-docs","owner":"fairdataihub","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-25T16:04:23.000Z","size":5175,"stargazers_count":1,"open_issues_count":12,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-25T17:22:56.792Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.codefair.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fairdataihub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":"codemeta.json"}},"created_at":"2024-06-18T17:25:45.000Z","updated_at":"2024-12-10T23:54:31.000Z","dependencies_parsed_at":"2024-08-27T19:03:59.286Z","dependency_job_id":"ec605b12-b7c6-45ca-a688-18ce7184e0fc","html_url":"https://github.com/fairdataihub/codefair-docs","commit_stats":null,"previous_names":["fairdataihub/codefair-docs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fairdataihub","download_url":"https://codeload.github.com/fairdataihub/codefair-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246934849,"owners_count":20857285,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-16T00:16:39.888Z","updated_at":"2025-04-03T04:23:25.582Z","avatar_url":"https://github.com/fairdataihub.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cimg src=\"https://freesvg.org/img/1653682897science-svgrepo-com.png\" alt=\"logo\" width=\"200\" height=\"auto\" /\u003e\n\n\u003cbr /\u003e\n\n\u003ch1\u003eCodefair Documentation\u003c/h1\u003e\n\n\u003cp\u003e\nDocumentation for the Codefair platform.\n\u003c/p\u003e\n\n  \u003ch4\u003e\n    \u003ca href=\"https://docs.codefair.io/\"\u003edocs.codefair.io\u003c/a\u003e\n  \u003c/h4\u003e\n  \n\u003cbr /\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-docs/graphs/contributors\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/contributors/fairdataihub/codefair-docs.svg?style=flat-square\" alt=\"contributors\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-docs/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/fairdataihub/codefair-docs.svg?style=flat-square\" alt=\"stars\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-docs/issues/\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/fairdataihub/codefair-docs.svg?style=flat-square\" alt=\"open issues\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-docs/blob/main/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg\" alt=\"license\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n   \n\u003ch4\u003e\n    \u003ca href=\"https://github.com/fairdataihub/codefair-docs/issues/\"\u003eReport Issues/Make suggestions\u003c/a\u003e\n  \u003c/h4\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n---\n\n## About\n\nCodefair 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.\n\n# :toolbox: Developer Instructions\n\n## :bangbang: Prerequisites\n\nThis project uses `yarn` as the package manager. If you do not have `yarn` installed, you can install it with the following command:\n\n```bash\nnpm install -g yarn\n```\n\nIf you already have a conda environment on your machine, you can install the dependencies with:\n\n```bash\nconda install -c conda-forge yarn nodejs\n```\n\n## :running: Run Locally\n\nClone the project\n\n```bash\ngit clone https://github.com/fairdataihub/codefair-docs.git\n```\n\nInstall the dependencies\n\n```bash\nyarn install\n```\n\nStart the server\n\n```bash\nyarn dev\n```\n\n## :building_construction: Build Locally\n\nUse this to build a local production version of the site. User `docs:serve` to preview the local build.\n\n```bash\nyarn docs:build\n```\n\n## :arrow_forward: Submitting a PR\n\nIf you are an external contributor, please make a fork of the repository and submit a PR from your fork.\n\n1. Create a new branch from the `main` branch.\n2. Make your changes. You can test your changes locally by running `yarn dev`. Make sure to check the console for any errors.\n3. Test your changes on a local build by running `yarn build` and `yarn serve`. If this works, you can submit yout changes.\n4. Push your changes to the remote branch.\n5. Create a PR to merge your branch into `main`.\n\nYou 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.\n\n## :triangular_flag_on_post: Deployment\n\nYou 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.\n\n## Contributing\n\n\u003ca href=\"https://github.com/fairdataihub/codefair-docs/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=fairdataihub/codefair-docs\" /\u003e\n\u003c/a\u003e\n\n## License\n\nThis work is licensed under a\n[Creative Commons Attribution 4.0 International License][cc-by]. See [LICENSE](LICENSE.txt) for more information.\n\n[cc-by]: http://creativecommons.org/licenses/by/4.0/\n[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png\n\n[![CC BY 4.0][cc-by-image]][cc-by]\n\n## Acknowledgements\n\nThis 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.\n\n---\n\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n\u003ca href=\"https://codefair.io\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/fairdataihub/codefair-app/main/ui/public/assets/images/codefair_logo.png\" alt=\"logo\" width=\"200\" height=\"auto\" /\u003e\n\u003c/a\u003e\n\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Fcodefair-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffairdataihub%2Fcodefair-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Fcodefair-docs/lists"}