No description
Find a file
Snider bd5a08e2a1 Add origin URL to AGENTS.md (#7)
Added origin URL for AGENTS.md
2025-10-27 13:23:15 +00:00
cmd Fix typo in lipgloss method call: NewNewStyle -> NewStyle 2025-10-27 06:03:42 +00:00
config Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
crypt Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
display Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +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 Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
i18n Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
io Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
pkg Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
workspace Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
.coderabbit.yaml Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
.gitignore git keep before a gitignore 2025-10-27 03:39:07 +00:00
AGENTS.md Add origin URL to AGENTS.md (#7) 2025-10-27 13:23:15 +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
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 Add documentation for Core modules: Config, Crypt, Display, Docs, IO, and Workspace (#3) 2025-10-27 03:14:50 +00:00
go.work.sum Add an initial CLI framework for Core 2025-10-27 05:07:22 +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 Adding documentation checkpoint. 2025-10-25 09:24:50 +01: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(),
)

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.