{"id":23053164,"url":"https://github.com/fairdataihub/fairshare-docs","last_synced_at":"2025-08-15T03:32:25.669Z","repository":{"id":36971924,"uuid":"434786648","full_name":"fairdataihub/FAIRshare-Docs","owner":"fairdataihub","description":"Documentation for the FAIRshare application","archived":false,"fork":false,"pushed_at":"2024-12-03T11:58:36.000Z","size":9139,"stargazers_count":6,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-03T12:42:07.535Z","etag":null,"topics":["covid-19","curation","documentation","electron","macos","ubuntu","windows"],"latest_commit_sha":null,"homepage":"https://docs.fairshareapp.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":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-12-04T02:20:26.000Z","updated_at":"2024-05-10T18:48:19.000Z","dependencies_parsed_at":"2023-02-17T01:01:52.158Z","dependency_job_id":"e99636e3-276f-48cd-8f2d-37285b570d0c","html_url":"https://github.com/fairdataihub/FAIRshare-Docs","commit_stats":null,"previous_names":[],"tags_count":62,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2FFAIRshare-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2FFAIRshare-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2FFAIRshare-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fairdataihub%2FFAIRshare-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fairdataihub","download_url":"https://codeload.github.com/fairdataihub/FAIRshare-Docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229890103,"owners_count":18140043,"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":["covid-19","curation","documentation","electron","macos","ubuntu","windows"],"created_at":"2024-12-16T00:16:45.162Z","updated_at":"2024-12-16T00:16:45.830Z","avatar_url":"https://github.com/fairdataihub.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n  \u003cimg src=\"static/img/logo.svg\" alt=\"logo\" width=\"200\" height=\"auto\" /\u003e\n  \u003ch1\u003eFAIRshare Documentation\u003c/h1\u003e\n  \n  \u003cp\u003e\n    A comprehensive documentation of the FAIRshare project!\n  \u003c/p\u003e\n\n\u003cp\u003e\n  \u003ca href=\"https://github.com/fairdataihub/FAIRshare-Docs/graphs/contributors\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/contributors/fairdataihub/FAIRshare-Docs.svg?style=flat-square\" alt=\"contributors\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/last-commit/fairdataihub/FAIRshare-Docs?style=flat-square\" alt=\"last update\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/FAIRshare-Docs/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/fairdataihub/FAIRshare-Docs.svg?style=flat-square\" alt=\"stars\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/FAIRshare-Docs/issues/\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/issues/fairdataihub/FAIRshare-Docs.svg?style=flat-square\" alt=\"open issues\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/fairdataihub/FAIRshare-Docs/blob/main/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/fairdataihub/FAIRshare-Docs.svg?style=flat-square\" alt=\"license\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://doi.org/10.5281/zenodo.6407283\"\u003e\n    \u003cimg src=\"https://zenodo.org/badge/DOI/10.5281/zenodo.6407283.svg\" alt=\"doi\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://fairdataihub.org/fairshare\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Curated%20with-FAIRshare-yellow\" alt=\"Curated with FAIRshare\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://docs.fairshareapp.io/\"\u003e\n    \u003cimg src=\"https://api.checklyhq.com/v1/badges/checks/2c8f5695-1596-4ad6-b1ae-a30c42ccec9b?style=flat\u0026theme=default\" alt=\"checkly status\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://docs.fairshareapp.io/\"\u003e\n    \u003cimg src=\"https://api.checklyhq.com/v1/badges/checks/2c8f5695-1596-4ad6-b1ae-a30c42ccec9b?style=flat\u0026theme=default\u0026responseTime=true\" alt=\"checkly response time\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n   \n\u003ch4\u003e\n    \u003ca href=\"https://docs.fairshareapp.io/docs/intro\"\u003eWhat is FAIRshare?\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://docs.fairshareapp.io/\"\u003eDocumentation\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://docs.fairshareapp.io/docs/changelog\"\u003eChangelog\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://github.com/fairdataihub/FAIRshare-Docs/issues/\"\u003eReport Bug\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://fairdataihub.org/contact-us\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/h4\u003e\n\u003c/div\u003e\n\n\u003cbr /\u003e\n\n# :notebook_with_decorative_cover: Table of Contents\n\n- [About the Documentation](#star2-about-the-documentation)\n  - [Tech Stack](#space_invader-tech-stack)\n  - [Color Reference](#art-color-reference)\n  - [Environment Variables](#key-environment-variables)\n- [Getting Started](#toolbox-getting-started)\n  - [Prerequisites](#bangbang-prerequisites)\n  - [Run Locally](#running-run-locally)\n  - [Versioning](#stopwatch-versioning)\n  - [Build locally](#building_construction-build-locally)\n  - [Deployment](#triangular_flag_on_post-deployment)\n- [Contributing](#wave-contributing)\n  - [Code of Conduct](#scroll-code-of-conduct)\n- [FAQ](#grey_question-faq)\n- [License](#warning-license)\n- [Contact](#handshake-contact)\n- [Acknowledgements](#gem-acknowledgements)\n\n## :star2: About the Documentation\n\n### :space_invader: Tech Stack\n\n\u003cdetails\u003e\n  \u003csummary\u003eClient\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://reactjs.org/\"\u003eReact.js\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"https://tailwindcss.com/\"\u003eTailwindCSS\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eServer\u003c/summary\u003e\n  \u003cul\u003e\n    \u003cli\u003e\u003ca href=\"https://docusaurus.io/\"\u003eDocusaurus\u003c/a\u003e\u003c/li\u003e\n  \u003c/ul\u003e\n\u003c/details\u003e\n\n### :art: Color Reference\n\n| Color           | Hex                                                              |\n| --------------- | ---------------------------------------------------------------- |\n| Primary Color   | ![#1E40AF](https://via.placeholder.com/10/1E40AF?text=+) #1E40AF |\n| Secondary Color | ![#F97316](https://via.placeholder.com/10/F97316?text=+) #F97316 |\n| Accent Color    | ![#6B7280](https://via.placeholder.com/10/6B7280?text=+) #6B7280 |\n| Text Color      | ![#1C1E21](https://via.placeholder.com/10/1C1E21?text=+) #1C1E21 |\n\n### :key: Environment Variables\n\nTo run this project, you will need to add the following environment variables to your `.env.local` file\n\n- None at the moment\n\n## :toolbox: Getting Started\n\n### :bangbang: Prerequisites\n\nThis project uses Yarn as package manager\n\n```bash\nnpm install --global yarn\n```\n\n### :running: Run Locally\n\nClone the project\n\n```bash\ngit clone https://github.com/fairdataihub/FAIRshare-Docs.git\n```\n\nGo to the project directory\n\n```bash\ncd FAIRshare-Docs\n```\n\nInstall dependencies\n\n```bash\nyarn install\n```\n\nStart the server\n\n```bash\nyarn start\n```\n\n### :stopwatch: Versioning\n\nYou can use the version script to create a new documentation version based on the latest content in the `docs` directory. That specific set of documentation will then be preserved and accessible even as the documentation in the `docs` directory changes moving forward.\n\nIdeally, you should create a new branch and update the relevant pages. Then send a PR with [@megasanjay](https://github.com/megasanjay) on the review page.\n\nOnly do these steps after all changes to the documentation for the specific version have been completed:\n\n1. Update the docs changelog to be on parity with the changelog in [@FAIRshare](https://github.com/fairdataihub/FAIRshare/blob/main/CHANGELOG.md)\n2. Make sure the current docs version (the `docs` directory) is ready to be frozen.\n3. Update the `version` key in package.json for this repository.\n\n```bash\nyarn run docusaurus docs:version 5.3.0\n```\n\nThis will freeze the current version of the documentation. The files under the current `docs` directory will be considered to be `Upcoming 🚧` version.\n\n### :building_construction: Build locally\n\nUse this step to build a local production version of the site. Use `serve` to preview the local build.\n\n```bash\nyarn build\nyarn serve\n```\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## :wave: Contributing\n\n\u003ca href=\"https://github.com/fairdataihub/FAIRshare-Docs/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=fairdataihub/FAIRshare-Docs\" /\u003e\n\u003c/a\u003e\n\nContributions are always welcome!\n\nSee [`contributing.md`](https://github.com/fairdataihub/FAIRshare-Docs/blob/main/CONTRIBUTING.md) for ways to get started.\n\n### :scroll: Code of Conduct\n\nPlease read the [Code of Conduct](https://github.com/fairdataihub/FAIRshare-Docs/blob/master/CODE_OF_CONDUCT.md)\n\n## :grey_question: FAQ\n\n- Can I make changes to previous versions of the documentation?\n\n  - Yes, you can make changes to previous versions of the documentation. You can do this by creating a new branch and adding your changes directly in the `versioned_docs` directory.\n\n## :warning: License\n\nDistributed under the MIT License. See [`LICENSE`](https://github.com/fairdataihub/FAIRshare-Docs/blob/main/LICENSE) for more information.\n\n## :handshake: Contact\n\nContact us on Twitter: [@fairdataihub](https://twitter.com/fairdataihub)\n\nSend us an E-mail: info@fairdataihub.org\n\nProject Link: [FAIRshare](https://github.com/fairdataihub/FAIRshare)\n\n## :gem: Acknowledgements\n\nA special thank you to Vercel for hosting our application documentation.\n\n\u003ca href=\"https://vercel.com/?utm_source=fairdataihub\u0026utm_campaign=oss\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://www.datocms-assets.com/31049/1618983297-powered-by-vercel.svg\"  width=\"auto\"/\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Ffairshare-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffairdataihub%2Ffairshare-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffairdataihub%2Ffairshare-docs/lists"}