Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 4.46 KB

README.md

File metadata and controls

96 lines (66 loc) · 4.46 KB
Raw

fairdataihub.org

CodeFactor Security Rating Bugs Vulnerabilities Duplicated Lines (%) Reliability Rating Technical Debt Code Smells Maintainability Rating Status Ping Average Response

Project setup

Make sure to install the dependencies.

yarn install

Compiles and hot-reloads for development

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

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.

yarn build
yarn start

Documentation

We recommend to look at the documentation.

Requirements

  • Node.js >= 12.22.0
  • Yarn 1 (Classic)

Directory Structure

  • .github — GitHub configuration including the CI workflow.
  • .husky — Husky configuration and hooks.
  • public — Static assets such as robots.txt, images, and favicon.
  • src — Application source code, including pages, components, styles.
  • 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.

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