Tropy

Tropy 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][docs] and join the discussion on the [forums][].

Interested to work on Tropy or create your own builds? Please find more details below. Happy hacking!

[tropy.org]: https://tropy.org [@tropy@fosstodon.org]: https://fosstodon.org/@tropy [docs]: https://docs.tropy.org [forums]: https://forums.tropy.org

Installation 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][].

[release page]: https://github.com/tropy/tropy/releases/latest [Homebrew]: https://brew.sh [winget]: https://winget.run [AUR]: https://aur.archlinux.org [Flatpak]: https://flathub.org/en/apps/org.tropy.Tropy

Installation from Source 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 $ npm rebuild 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, run:

$ npm test

[Node.js]: https://nodejs.org [Electron]: https://electronjs.org [node-gyp]: https://www.npmjs.com/package/node-gyp [repository]: https://github.com/tropy/tropy

Creating Builds 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.

Tropy Development 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

$ npm test

Run individual tests in main/renderer process

$ npx spark test/common/db.test.js $ npx spark --renderer test/common/db.test.js

Collect test code coverage