https://github.com/maastrichtu-ids/fairificator
Tool to evaluate how FAIR is a resource URL using the F-UJI API
https://github.com/maastrichtu-ids/fairificator
evaluation fair fair-data fair-principles metrics
Last synced: about 2 months ago
JSON representation
Tool to evaluate how FAIR is a resource URL using the F-UJI API
- Host: GitHub
- URL: https://github.com/maastrichtu-ids/fairificator
- Owner: MaastrichtU-IDS
- License: mit
- Created: 2021-09-10T18:05:26.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-14T08:43:11.000Z (over 2 years ago)
- Last Synced: 2025-03-08T00:31:45.665Z (3 months ago)
- Topics: evaluation, fair, fair-data, fair-principles, metrics
- Language: TypeScript
- Homepage:
- Size: 7.49 MB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# FAIRificator, FAIR evaluation tool
[](https://github.com/MaastrichtU-IDS/fairificator/actions/workflows/deploy-github.yml) [](https://github.com/MaastrichtU-IDS/fairificator/actions/workflows/codeql-analysis.yml)
Evaluate how FAIR (Findable, Accessible, Interoperable, Reusable) a resource URL is with the [FAIRsFAIR F-UJI API](https://github.com/pangaea-data-publisher/fuji)
Built with [TypeScript](https://www.typescriptlang.org/), [React](https://reactjs.org/), and [Material-UI](https://material-ui.com/). Deployed as a static website on [GitHub Pages](https://pages.github.com/).
## Access đŠâđģ
Access the website at **[https://maastrichtu-ids.github.io/fairificator đ](https://maastrichtu-ids.github.io/fairificator)**
It uses the F-UJI API hosted at https://fuji-137-120-31-148.sslip.io/fuji/api/v1/ui
You can provide the resource URL to evaluate directly as a URL parameter to load the evaluation for a specific URL with `?evaluate=https://resource`
## Run in development đī¸
Requirements: [npm](https://www.npmjs.com/get-npm) and [yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable) installed.
Clone the repository, and get in the folder:
```bash
git clone https://github.com/MaastrichtU-IDS/fairificator
cd fairificator
```
Install dependencies :inbox_tray:
```bash
yarn
```
Web app will run on [http://localhost:19006 đ](http://localhost:19006)
```bash
yarn dev
```
> The website should reload automatically at each changes to the code :arrows_clockwise:
Upgrade the packages versions in `yarn.lock` âĢī¸
```bash
yarn upgrade
```
## Run in production đŠī¸
This website is automatically deployed by a [GitHub Actions worklow](https://github.com/MaastrichtU-IDS/fairificator/actions?query=workflow%3A%22Deploy+to+GitHub+Pages%22) to GitHub Pages at https://maastrichtu-ids.github.io/fairificator
You can build locally in the `/web-build` folder, and serve on [http://localhost:5000](http://localhost:5000)
```bash
yarn build
yarn serve
```
Or run directly using [Docker :whale:](https://docs.docker.com/get-docker/) (requires [docker installed](https://docs.docker.com/get-docker/))
```bash
docker-compose up
```
> Checkout the [docker-compose.yml](/docker-compose.yml) file to see how we run the Docker image âĩī¸