Bring order to your research — use the power of Tropy to organize and describe your research photos so you can find your sources whenever you need them.
Visit tropy.org to learn more or follow @tropy@fosstodon.org for important announcements. To get started, download the latest version of Tropy for your platform, check out the user's manual and join the discussion on the forums.
Interested to work on Tropy or create your own builds? Please find more details below. Happy hacking!
Visit tropy.org or the release page to download the latest version of Tropy.
You can also install Tropy via Homebrew, winget, or the AUR.
For Linux users, we recommended to install Tropy with Flatpak.
Install the latest version of Node.js (at least the version that ships with the current Electron release) and all dependencies required to use node-gyp on your platform.
Clone this repository and install Tropy's dependencies:
$ npm install --ignore-scripts
$ npx install-electron
$ node scripts/rebuild.js --force
On Linux, use the --global-libvips flag when rebuilding
to link against the system's libvips.
To test that everything works, compile the bundle and run the tests:
$ npm run rollup
$ npm test
To create a dev-build for your current platform run npm run build.
This will create a dev-build of Tropy in the dist folder.
Use the following commands for Tropy development:
# Compile the production bundle (optionally in --watch mode)
$ npm run rollup -- --watch
# Run bundle in dev mode
$ npm start
# View or tail the log file
$ npm run log:view
$ npm run log:tail
# Run all tests: unit tests (spark) and end-to-end tests
# (the e2e tests need a current bundle)
$ npm test
# Run individual tests in main/renderer process
$ npx spark -m test/common/util.test.js
$ npx spark -r test/common/db.test.js
# Collect test code coverage of all tests or of individual tests
$ npm run coverage
$ npx c8 spark -m test/common/db.test.js
# Render the last coverage as HTML (coverage/index.html)
$ npx c8 report -r html
You can extend Tropy's functionality via plugins. To find out more, consult the plugin specification and clone the sample plugin to get started.