Skip to content

tropy/tropy

Repository files navigation

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 @[email protected] 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!

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.

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
$ npm run rebuild -- --force

To test that everything works, run:

$ npm test

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

Start Tropy in dev-mode by running npm start.

Plugin Development

You can extend Tropy's functionality via plugins. To find out more, consult the plugin specification and clone the sample plugin to get started.