Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fairdataihub/fairdataihub.org

Website of the FAIR Data Innovations Hub
https://github.com/fairdataihub/fairdataihub.org

data fair nextjs organization software typescript

Last synced: about 2 months ago
JSON representation

Website of the FAIR Data Innovations Hub

Host: GitHub
URL: https://github.com/fairdataihub/fairdataihub.org
Owner: fairdataihub
License: mit
Created: 2021-06-25T20:36:16.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-12-08T09:47:59.000Z (2 months ago)
Last Synced: 2024-12-08T10:25:58.521Z (2 months ago)
Topics: data, fair, nextjs, organization, software, typescript
Language: TypeScript
Homepage: https://fairdataihub.org
Size: 69.1 MB
Stars: 10
Watchers: 4
Forks: 8
Open Issues: 21
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        # [fairdataihub.org](https://fairdataihub.org)

[![CodeFactor](https://www.codefactor.io/repository/github/fairdataihub/fairdataihub.org/badge)](https://www.codefactor.io/repository/github/fairdataihub/fairdataihub.org)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=bugs)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=fairdataihub_fairdataihub-website&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=fairdataihub_fairdataihub-website)

![Status](https://status.fairdataihub.org/api/badge/1/status)

![Ping](https://status.fairdataihub.org/api/badge/1/ping/24)

![Average Response](https://status.fairdataihub.org/api/badge/1/avg-response/24)

## Project setup

Make sure to install the dependencies.

```bash

yarn install

```

### Compiles and hot-reloads for development

Start the development server on http://localhost:3000

```bash

yarn dev

```

### Compiles and minifies for production

Use this step to build a local production version of the site. Use `start` to preview the local build.

```bash

yarn build

yarn start

```

## Documentation

We recommend to look at the [documentation](https://nextjs.org/docs/getting-started).

### Requirements

- Node.js >= 12.22.0

- Yarn 1 (Classic)

### Directory Structure

- [`.github`](.github) — GitHub configuration including the CI workflow.


- [`.husky`](.husky) — Husky configuration and hooks.


- [`public`](./public) — Static assets such as robots.txt, images, and favicon.


- [`src`](./src) — Application source code, including pages, components, styles.

- [`cypress`](./cypress) — End-to-end tests.

### Scripts

- `yarn dev` — Starts the application in development mode at `http://localhost:3000`.

- `yarn build` — Creates an optimized production build of your application.

- `yarn start` — Starts the application in production mode.

- `yarn type-check` — Validate code using TypeScript compiler.

- `yarn lint` — Runs ESLint for all files in the `src` directory.

- `yarn format` — Runs Prettier for all files in the `src` directory.

- `yarn cypress:run` — Runs Cypress tests in headless mode.

- `yarn cypress:open` — Opens Cypress in interactive mode.

### Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the `@` prefix.

```tsx

import { Button } from '@/components/Button';

// To import images or other files from the public folder

import avatar from '@/public/avatar.png';

```

## Note

This branch is a work in progress. We are actively working on improving the website.

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information.

Note: 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.

## Acknowledgements

A special thank you to Vercel for hosting this website.