Skip to content

Getting Started

Use a tool (no setup needed)

  1. Go to freedatastore.online
  2. Pick a tool (Data Profiler, Cleaner, Validator, Converter, Explorer)
  3. Drop your file
  4. Done — everything runs in your browser

Use the SDK in your own project

npm install @freedatastore/sdk
import { loadFile, profile } from '@freedatastore/sdk';

// Load a file picked by the user
const input = document.querySelector('input[type="file"]');
input.addEventListener('change', async () => {
  const file = input.files[0];
  const { table, rows, columns } = await loadFile(file);
  console.log(`Loaded ${rows} rows, ${columns.length} columns`);

  const report = await profile(table);
  console.log(report);
});

Build a data tool

See Contributing a Tool for the full guide.

Quick start:

# Clone the template
git clone https://github.com/freedatastore-online/template-data-tool my-tool
cd my-tool

# Install and run
pnpm install
pnpm dev