No description
Find a file
2025-10-30 14:18:37 +00:00
.github/workflows Refactor PGP module with helper functions and error handling title (#8) 2025-10-30 14:18:37 +00:00
cmd Refactor PGP module with helper functions and error handling title (#8) 2025-10-30 14:18:37 +00:00
config Refactor services and tests: update Config, Workspace, Display, and cryptography modules; add test-gen and PWA build support; improve workspace test utilities and mock implementations; and enhance file handling logic. 2025-10-28 21:42:29 +00:00
crypt Refactor services and tests: update Config, Workspace, Display, and cryptography modules; add test-gen and PWA build support; improve workspace test utilities and mock implementations; and enhance file handling logic. 2025-10-28 21:42:29 +00:00
display Refactor services and tests: update Config, Workspace, Display, and cryptography modules; add test-gen and PWA build support; improve workspace test utilities and mock implementations; and enhance file handling logic. 2025-10-28 21:42:29 +00:00
docs Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
help Refactor services and tests: update Config, Workspace, Display, and cryptography modules; add test-gen and PWA build support; improve workspace test utilities and mock implementations; and enhance file handling logic. 2025-10-28 21:42:29 +00:00
i18n Refactor services and tests: update Config, Workspace, Display, and cryptography modules; add test-gen and PWA build support; improve workspace test utilities and mock implementations; and enhance file handling logic. 2025-10-28 21:42:29 +00:00
pkg Refactor PGP module with helper functions and error handling title (#8) 2025-10-30 14:18:37 +00:00
workspace Refactor services and tests: update Config, Workspace, Display, and cryptography modules; add test-gen and PWA build support; improve workspace test utilities and mock implementations; and enhance file handling logic. 2025-10-28 21:42:29 +00:00
.gitignore Refactor PGP module with helper functions and error handling title (#8) 2025-10-30 14:18:37 +00:00
AGENTS.md Refactor PGP module with helper functions and error handling title (#8) 2025-10-30 14:18:37 +00:00
core.go Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
core_test.go Add options type to Config service and improve type assignment error handling; add unit tests for Config functionality 2025-10-28 11:09:38 +00:00
go.mod Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
go.sum Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
go.work Refactor service documentation to standardize naming conventions and improve clarity 2025-10-28 12:06:24 +00:00
go.work.sum Refactor services and tests: update Config, Workspace, Display, and cryptography modules; add test-gen and PWA build support; improve workspace test utilities and mock implementations; and enhance file handling logic. 2025-10-28 21:42:29 +00:00
LICENSE.txt Add initial project structure with core functionality and basic files 2025-10-24 04:55:10 +01:00
Makefile Add pre-commit task, CLI enhancements, and ATS updates 2025-10-27 05:41:11 +00:00
README.md Refactor PGP module with helper functions and error handling title (#8) 2025-10-30 14:18:37 +00:00
Taskfile.yml Refactor PGP module with helper functions and error handling title (#8) 2025-10-30 14:18:37 +00:00

Core

Core is an opinionated Go framework for building desktop apps with Wails. It provides a small set of focused modules:

  • Core — framework bootstrap and service container
  • Core.Config — app and UI state persistence
  • Core.Crypt — keys, encrypt/decrypt, sign/verify
  • Core.Display — windows, tray, window state
  • Core.Docs — inapp help and deeplinks
  • Core.IO — local/remote filesystem helpers
  • Core.Workspace — projects and paths

Help: https://Core.Help
Web: https://dAppCo.re
Repo: https://github.com/Snider/Core

Quick start

import core "github.com/Snider/Core"

app := core.New(
  core.WithServiceLock(),
)

Tasks

This project uses Task for task automation. The root Taskfile.yml includes the Taskfile.yml from cmd/core-gui and cmd/core under the gui and cli namespaces respectively. The following tasks are available:

General

  • task test: Run all Go tests recursively for the entire project.
  • task review: Run CodeRabbit review to get feedback on the current changes.
  • task check: Run go mod tidy, the full test suite, and a CodeRabbit review.

GUI Application (cmd/core-gui)

  • task gui:build: Builds the GUI application.
  • task gui:package: Packages a production build of the GUI application.
  • task gui:run: Runs the GUI application.
  • task gui:dev: Runs the GUI application in development mode.

CLI Application (cmd/core)

  • task cli:build: Builds the CLI application.
  • task cli:build:dev: Builds the CLI application for development.
  • task cli:run: Builds and runs the CLI application.

Docs (MkDocs)

The help site and inapp docs are built with MkDocs Material and live under pkg/v1/core/docs.

  • Live preview: from pkg/v1/core/docs run
    • pip install -r requirements.txt
    • mkdocs serve -o -c (or task dev if you use Task)
  • Build static site: mkdocs build --clean -d public (or task build)

The demo app embeds the built docs from public/ and can open specific sections in new windows using stable, short headings.