Wealthfolio

A Beautiful and Boring Desktop Investment Tracker

Website · Discord · Twitter · Releases

Wealthfolio App is a Beautiful and Boring Investment Tracker, with Local Data Storage. No Subscriptions, No Cloud.

Visit the app website at Wealthfolio App.

See ROADMAP.md.

Ensure you have the following installed on your machine:

• Node.js
• pnpm
• Rust
• Tauri

1. Clone the repository:

   git clone https://github.com/afadil/wealthfolio.git
   cd wealthfolio

2. Install dependencies using pnpm:

   pnpm install

3. Run in Development Mode:

Build and run the desktop application using Tauri:

pnpm tauri dev

4. Build for Production:

Build the application for production:

pnpm tauri build

For a consistent development environment across all platforms, you can use the provided DevContainer configuration. This method requires fewer manual setup steps and provides an isolated environment with all necessary dependencies.

• Docker
• Visual Studio Code
• Remote - Containers VS Code extension

• Pre-configured Tauri development environment
• X11 virtual display with VNC access (port 5900)
• Complete Rust development setup
• GPU support (via Docker's --gpus=all flag)
• Persistent data and build caches
• Essential VS Code extensions pre-installed

1. Clone the repository (if you haven't already):

   git clone https://github.com/afadil/wealthfolio.git
   cd wealthfolio

2. Open in VS Code:

   • Open VS Code
   • Go to File > Open Folder
   • Select the wealthfolio directory

3. Launch DevContainer:

   • Press F1 or Ctrl+Shift+P
   • Type "Remote-Containers: Reopen in Container"
   • Press Enter

4. Wait for container build:

   • VS Code will build and configure the development container
   • This may take a few minutes on first run

5. Start Development:

   • Once the container is ready, you can start development
   • All necessary tools and dependencies will be available

• React: JavaScript library for building user interfaces.
• React Router: Declarative routing for React.
• Tailwind CSS: Utility-first CSS framework for styling.
• Radix UI/Shadcn: Accessible UI components.
• Recharts: Charting library built with React.
• React Query: Data-fetching library for React.
• Zod: TypeScript-first schema declaration and validation library.

• Tauri: Framework for building tiny, secure, and fast desktop applications.

• Vite: Next-generation frontend tooling.
• TypeScript: Typed superset of JavaScript.
• ESLint: Pluggable linting utility for JavaScript and JSX.
• Prettier: Code formatter.

wealthfolio/
├── src/                 # Main source code for the React application
├── src-core/            # Core backend functionality
├── src-tauri/           # Tauri-specific code for desktop app functionality
├── public/              # Public assets
├── LICENSE              # License file
├── README.md            # Project documentation
├── ROADMAP.md           # Future plans and roadmap
├── components.json      # Component configuration
├── package.json         # Node.js dependencies and scripts
├── pnpm-lock.yaml       # Lock file for pnpm
├── postcss.config.js    # PostCSS configuration
├── tailwind.config.js   # Tailwind CSS configuration
├── tsconfig.json        # TypeScript configuration
└── vite.config.ts       # Vite build tool configuration

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

This project is licensed under the AGPL-3.0 license. See the LICENSE file for details.

Enjoy managing your wealth with Wealthfolio! 🚀