datannur

datannur is a portable data catalog that can run without a server.

This repository contains proprietary code with the source available. Before using or contributing, please review the full License. If you're looking for the built version of the app, you can find it in this repository: datannur-app.

For more information check the website.

Why

datannur, the portable data catalog

Allows you to centralize, search and visualize information across a collection of datasets

Aims to improve data organization and to ease their sharing and documentation

Simple and flexible, quickly integrates into all types of environments

• Easy : No installation or configuration required. datanur is the easiest catalog to implement and maintain

• Portable : Works anywhere (local, cloud, shared drive), one folder that can be copied, moved, sent and opened with any browser

• Complete : Flexible, complete and structured around 7 concepts with a high level of detail: Institution, Folder, Keyword, Doc, Dataset, Variable, and Modality

• Secure : Because it is a simple HTML interface isolated in the browser, the application cannot modify anything on the machine and thus poses no risk

Tech stack

The app is a SPA 100% client-side using Svelte as the main framework and Vite for developpement and bundling. The app depends heavily on Datatables and his plugins. SCSS are also used for style and a subset of Bulma CSS has been used for some components. You can check the package.json to see all dependencies.

Usage

1. Download the repo
2. Run npm install

• Run npm run dev to start the dev server
• Run npm run build to build the production app
• Run npm run preview to view the production app

Dependencies licences

• Font Awesome Free : Icons CC BY 4.0 License, Fonts SIL OFL 1.1 License, Code MIT License - https://fontawesome.com/license/free
• Bulma : MIT License - https://github.com/jgthms/bulma
• DataTables : MIT License - https://github.com/DataTables/DataTablesSrc
• FileSaver.js : MIT License - https://github.com/eligrey/FileSaver.js
• Fitty : MIT License - https://github.com/rikschennink/fitty
• FlexSearch : Apache 2.0 License - https://github.com/nextapps-de/flexsearch
• jQuery : MIT License - https://github.com/jquery/jquery
• PowerTip : MIT License - https://github.com/stevenbenner/jquery-powertip
• Jsonjsdb : MIT License - https://github.com/bassim-matar/jsonjsdb/tree/main/jsonjsdb
• JSZip : MIT License - https://github.com/Stuk/jszip
• Marked : MIT License - https://github.com/markedjs/marked
• Mermaid : MIT License - https://github.com/mermaid-js/mermaid
• MiniMasonry.js : MIT License - https://github.com/Spope/MiniMasonry.js
• Navigo : MIT License - https://github.com/krasimir/navigo
• jsdiff : BSD 3-Clause License - https://github.com/kpdecker/jsdiff

Dev dependencies licences

• rollup/plugin-alias : MIT License - https://github.com/rollup/plugins/tree/master/packages/alias#readme
• sveltejs/vite-plugin-svelte : MIT License - https://github.com/sveltejs/vite-plugin-svelte
• Autoprefixer : MIT License - https://github.com/postcss/autoprefixer
• Jsonjsdb_editor : MIT License - https://github.com/bassim-matar/jsonjsdb/tree/main/jsonjsdb_editor
• open-cli : MIT License - https://github.com/sindresorhus/open-cli
• Puppeteer: Apache 2.0 License - https://github.com/puppeteer/puppeteer
• Rollup Plugin Visualizer : MIT License - https://github.com/btd/rollup-plugin-visualizer
• Sass : MIT License - https://github.com/sass/sass
• sitemap : MIT License - https://github.com/ekalinin/sitemap.js
• Svelte : MIT License - https://github.com/sveltejs/svelte
• Svelte Preprocess : MIT License - https://github.com/sveltejs/svelte-preprocess
• Vite : MIT License - https://github.com/vitejs/vite
• vite-plugin-full-reload : MIT License - https://github.com/ElMassimo/vite-plugin-full-reload
• Vitest : MIT License - https://github.com/vitest-dev/vitest