FAIR-Aware

FAIR-Aware is a self-assessment tool that raises awareness on data FAIRness (Findable, Accessible, Interoperable, Reusable).

Development

Prerequisites: Node.js v22+, pnpm, Docker

git clone https://github.com/DANS-KNAW/fair-assessment-tool.git
cd fair-assessment-tool
make setup

This builds the full Docker stack, seeds a default admin account (root@fairaware.system.com / admin123), and starts the application.

Run make help to see all available commands.

Production

Building

pnpm build

This compiles TypeScript and Tailwind CSS into the dist/ and public/ directories.

Database Setup

Import the schema into your MySQL 8.0 instance:

mysql -u <user> -p <database> < database_structure.sql

The database starts empty with no default users. Schema migrations run automatically on each app startup.

Creating the First Admin

Use the CLI to create an admin account:

node dist/cli.js create-admin --email admin@example.com --password <strong_password>

Starting the Server

node dist/index.js

The application will be available at http://localhost:3000 (or your configured APPLICATION_PORT).

Citation

If you use FAIR-Aware in your work, please cite: