Development of this application has moved to https://github.com/Arkisto-Platform/describo
If you're not a developer you should probably get a pre-built bundle from: https://uts-eresearch.github.io/describo/
Describo is a tool to describe and package data. It is a desktop app that runs on your Mac, Windows or Linux computer. You point it at a directory and it will allow you to describe the data therein as a Dataset using the RO-Crate Standard. RO-Crate uses a linked data approach to metadata - in describing your Dataset Data Item you will be able to add properties such as author - where the value is not just a string, but a Contextual Item - a Person - which in turn may link to other Contextual Items.
We do not have tutorial documentation yet but would be interested to hear what people make of the tool anyway.
If you follow the instructions below to run in a dev environment an application will start on your computer.
- ElectronJS
- VueJS
- ElementFE - component toolkit
- TailwindCSS
- Fontawesome Free Icons
- rclone
- Jest - tests
Install the packages and then start the dev env.
npm install
npm run develop
Hot updates are enabled so the app will reload when you save file changes.
There are two way to run the tests:
npm run testto run the tests on demandnpm run test-watchto start the test server in watch mode and re-run tests on spec file changes.
DO:
- create tests named as test-***.spec.js
- create the tests alongside the code being tested
The entry point to the Vue app is in src/renderer/index.js.
The store and route files are in that folder also. The
application components are in src/components whist the css
assets are in src/assets but since the app uses tailwindcss
you likely won't need to create any / many custom css classes.
See the wiki
See the wiki