{"id":23053182,"url":"https://github.com/fairdataihub/codefair-app","last_synced_at":"2025-04-03T04:23:41.667Z","repository":{"id":230472249,"uuid":"778532269","full_name":"fairdataihub/codefair-app","owner":"fairdataihub","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-19T20:28:41.000Z","size":24279,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-23T13:37:25.885Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://codefair.io","language":"HTML","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":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-03-27T22:30:30.000Z","updated_at":"2024-04-24T18:46:27.652Z","dependencies_parsed_at":"2024-03-30T00:26:17.169Z","dependency_job_id":"7a8f3f97-9987-4b9b-9816-a7f1dddcfa1a","html_url":"https://github.com/fairdataihub/codefair-app","commit_stats":null,"previous_names":["fairdataihub/codefair-app"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2Fcodefair-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fairdataihub","download_url":"https://codeload.github.com/fairdataihub/codefair-app/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246934867,"owners_count":20857287,"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:48.529Z","updated_at":"2025-04-03T04:23:41.639Z","avatar_url":"https://github.com/fairdataihub.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\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\n\u003cbr /\u003e\n\n\u003ch1\u003eCodefair\u003c/h1\u003e\n\n\u003cp\u003e\nYour coding assistant to make research software reusable without breaking a sweat!\n\u003c/p\u003e\n\n\u003cbr /\u003e\n    \u003ca href=\"https://github.com/marketplace/codefair-app\"\u003e\u003cstrong\u003e Get the app »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n\u003cbr /\u003e\n    \u003ca href=\"https://codefair.io/\"\u003e\u003cstrong\u003eLearn more »\u003c/strong\u003e\u003c/a\u003e\n\n\u003cbr /\u003e    \n\u003cbr /\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-app/graphs/contributors\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/contributors/fairdataihub/codefair-app.svg?style=flat-square\" alt=\"contributors\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-app/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/fairdataihub/codefair-app.svg?style=flat-square\" alt=\"stars\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-app/issues/\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/fairdataihub/codefair-app.svg?style=flat-square\" alt=\"open issues\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/codefair-app/blob/main/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/fairdataihub/codefair-app.svg?style=flat-square\" alt=\"license\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://doi.org/10.5281/zenodo.13376616\"\u003e\n    \u003cimg src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.13376616.svg\" alt=\"Zenodo DOI\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://archive.softwareheritage.org/browse/origin/https://github.com/fairdataihub/codefair-app/\"\u003e\n    \u003cimg src=\"https://archive.softwareheritage.org/badge/origin/https://github.com/fairdataihub/codefair-app/\" alt=\"Software Heritage archive\" /\u003e\n  \u003c/a\u003e\n\n\u003c/p\u003e\n\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n---\n\n## Description\n\nCodefair is your personal assistant when it comes to making your research software reusable and especially complying with the [Findable, Accessible, Interoperable, Reusable (FAIR) Principles for Research Software](https://doi.org/10.1038/s41597-022-01710-x). Whether you are developing artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter notebook, or data analysis code with R, Codefair is here to assist you. By communicating with you through GitHub issues and submitting pull requests, Codefair will make sure that your software follows best coding practices, provides metadata in standard format, includes a license file, is archived on Zenodo, and much more. With Codefair by your side, you're not just developing software but you're advocating for better software practices. Learn more on the app's website [codefair.io](https://codefair.io/).\n\n![screenshot of the License issue up to where is it closed with the PR](https://imgur.com/fcOuzTC.png)\n\n## Getting started\n\n### Installing\n\n1. Install Codefair from the [GitHub market place](https://github.com/marketplace/codefair-app) on the GitHub organizations or repositories of your choice\n2. Code as usual\n3. Track FAIR compliance issues through the Codefair issue dashboard and address them through the Codefair website.\n\n\u003e [!NOTE]\n\u003e While Codefair is free, installing it via the GitHub Marketplace may still require a credit card to be associated with your (or your organization’s) GitHub account. To circumvent this requirement, you can alternatively install Codefair directly from the [app page](https://github.com/apps/codefair-io).\n\n### Documentation\n\nSee our [dedicated webpage](https://docs.codefair.io/docs/installation.html) for full details on what permissions are used and the features Codefair provides.\n\n## Run the GitHub app locally\n\nFor detailed instructions on setting up running the application locally, please refer to our [documentation site](https://docs.codefair.io/dev/running-locally.html).\n\n## How Codefair is developed\n\nCodefair is developed using [Probot](https://probot.github.io/docs/) and is deployed on a server as a serverless function. The GitHub app is configured to receive webhooks for important actions such as pushing code, opening or closing issues, opening or merging pull requests and commenting on discussions.\nBy leveraging a serverless environment on a server, Codefair can automatically scale to handle the workload of the GitHub app. The app is written in [Node.js](https://nodejs.org/en) and utilizes the [Octokit library](https://github.com/octokit) to interact with the GitHub API enabling seamless integration with GitHub's features and functionality.\n\n## Contributing\n\n\u003ca href=\"https://github.com/fairdataihub/codefair-app/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=fairdataihub/codefair-app\" /\u003e\n\u003c/a\u003e\n\nContributions are always welcome!\n\nIf you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.\n\n## Issues and Feedback\n\nTo report any issues with the software, suggest improvements, or request a new feature, please open a new issue via the [Issues](https://github.com/fairdataihub/codefair-app/issues) tab. Alternatively, you can also use our [contact form](https://tally.so/r/3E0dao). Provide adequate information (operating system, steps leading to error, etc.) so we can help you efficiently.\n\n## License\n\nThis work is licensed under\n[MIT](https://opensource.org/licenses/mit). See [LICENSE](https://github.com/AI-READI/pyfairdatatools/blob/main/LICENSE) for more information.\n\n## How to cite\n\nIf you are using this package or reusing the source code from this repository for any purpose, please cite the corresponding Zenodo record. If you are using the latest version, you can see the citation instruction in the GitHub Citation panel or in the CITATION.cff file. You can also find the citation instruction on the Zenodo page https://doi.org/10.5281/zenodo.13376616 (especially if you would like to cite an older version). \n\n\u003cbr /\u003e\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_name.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-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffairdataihub%2Fcodefair-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Fcodefair-app/lists"}