Actual Sync

⚠️⚠️ Work In Progress ⚠️⚠️

The goal for this project is to migrate the actualbudget/actual-server source code over to use Go.

Roadmap

Current roadmap is documented on the roadmap discussion.

Architecture

The architecture is still somewhat of a WIP. But the high level gist looks like this.

main.go         - Root Entrypoint
cmd/            - CLI Entrypoint
internal/
    server.go   - Echo server implementation
    core        - Domain logic handler functions to be used in the routes
    routes      - Echo route handlers
    storage     - Implementations for the storage gateway [sqlite, memory] - (PostgreSQL) to follow if needed

CLI Usage

actual-sync serve

This command will start the actual-sync server

Synopsis

This command will start the actual-sync server with the specified configurations along with this command.

actual-sync serve [flags]

Options

  -d, --data-path string   Sets configuration & data directory path. 
                           Creates 'actual-sync' folder here, if it 
                           doesn't exist (default "$HOME")
      --debug              Runs actual-sync in development mode
      --headless           Runs actual-sync without the web app
  -h, --help               help for serve
  -l, --logs               Displays server logs
  -p, --port int           Runs actual-sync at specified port (default 5006)

Global options

      --config string   config file (default is /actual-sync/config.yaml relative to data-path)

Check out an example configuration here.

Development

Dependencies

Build dependencies

• Node.js
• go

Development dependencies

• golangci-lint

Steps to run

1. Install node_modules (actual-web)

$ npm install

2. Run go program

$ go run main.go serve --debug

NOTE: Run golangci-lint run after changes(if any) to ensure code quality.