nfaucher8 / actual-desktop Goto Github PK

This is a project to run Actual, as a desktop application. It includes actual-server built in and can be used locally or to connect to a remote server. This is great for people who might want a desktop application to connect to their remote Actual server or people who want to try out Actual locally without setting up a server to run it on.

It's very easy to get started. Clone this repo, install deps, and start it:

git clone https://github.com/nfaucher8/actual-desktop.git
cd actual-desktop
cd actual-server
git submodule init
git submodule update
cd ..
yarn
yarn start

1. Clone the repo
2. Enter the new directory
3. Enter the actual-server directory
4. Clone the submodule
5. Go back to the actual-desktop directory
6. Run yarn to install dependencies
7. Run yarn start to start the app

A new application should start and you'll see Actual.

actual-desktop can be built as an application for your operating system. This allows it to be used like any other application (instead of having to be run through yarn).

Attempts to build an application for your current operating system and architecture

Attempts to build an application for Linux

• outputs:
  • AppImage

Attempts to build an application for MacOS (can only be run on MacOS)

• outputs:
  • arm64 zipped .app
  • arm64 .dmg installer
  • x64 zipped /app
  • x64 .dmg installer
  • universal zipped .app
  • universal .dmg installer

Attempts to build an armv7l application for Linux

• outputs:
  • AppImage

Attempts to build an application for Windows

This will output different versions of the built application. A .msi installer and .exe installer that can be used to install Actual on a device. A portable .exe will also be created, this file can run Actual without having to install it on a device.

• outputs:
  • MSI Installer (x64)
  • Portable exe (x64)
  • Installer exe (x64)
  • MSI Installer (ia32)
  • Portable exe (ia32)
  • Installer exe (ia32)