Privatefolio

The Free* and Open-source Portfolio Manager - All your crypto assets in one place

Installation

Go to GitHub releases and download the latest version for your platform. Each release contains the binaries for Windows, Linux and macOS under the Assets dropdown.

On Windows, you can run the Privatefolio-<version>.Setup.exe executable directly.

On Linux, you can run sudo dpkg -i privatefolio_<version>_amd64.deb to install the package.

Features

Transaction Management: Track all your cryptocurrency transactions in one place Multi-chain Support: Support for multiple blockchains and platforms Portfolio Analytics: View detailed analytics about your portfolio performance Search Functionality: Search for assets, transactions, and actions Search transactions by transaction hash (just paste a transaction hash into the search bar) Price History: View historical price data for your assets

License

This project is licensed under the AGPLv3 (GNU Affero General Public License v3.0).

Key Points of the GNU AGPLv3 License

• Freedom to Use: You can use the software for any purpose, including commercial use.
• Freedom to Study and Modify: You can study how the program works and modify it to suit your needs, including for commercial purposes.
• Freedom to Distribute Copies: You can redistribute copies of the original program, helping others benefit from it.
• Freedom to Distribute Modified Versions: You are allowed to distribute your modified versions, including for profit. However, if you run a modified version of the software on a server and allow others to interact with it, you must provide the source code of the modified version to those users.

See the LICENSE file for more details.

For Developers

Privatefolio is built with modern technologies like TypeScript, React, Bun, and Electron. Contributions are welcome to improve the project further.

For detailed setup instructions, including prerequisites, installation, and testing, please refer to the CONTRIBUTING.md file.

How to Contribute

1. Fork the repository and clone it locally.
2. Install dependencies using yarn and build the project using yarn build.
3. Use yarn dev to start the development environment.
4. Check open issues or TODO comments in the codebase to find tasks to work on.
5. Join our Discord community to discuss development and get help.
6. When you are ready, commit your changes and submit a pull request.

For a complete example of adding a new feature, check out PR #46 which demonstrates how to add a new price API extension.

For Docker setup and deployment, see the Docker documentation.

Key Technologies

• Frontend: React, Vite, Material-UI
• Backend: Node.js, Bun runtime, SQLite
• Desktop App: Electron
• Deployment: Docker

Feel free to open issues for bugs or feature requests!