cli/docs/index.md

80 lines
1.7 KiB
Markdown
Raw Normal View History

2025-10-25 09:24:50 +01:00
---
title: Core.Help
---
# Overview
Core is an opinionated framework for building Go desktop apps with Wails, providing a small set of focused modules you can mix into your app. It ships with sensible defaults and a demo app that doubles as inapp help.
- Site: [https://dappco.re](https://dappco.re)
- Help: [https://core.help](https://core.help)
- Repo: [github.com:Snider/Core](https://github.com/Snider/Core)
2025-10-25 09:24:50 +01:00
## 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
## Quick start
```go
package main
import (
"github.com/wailsapp/wails/v3/pkg/application"
2025-10-25 09:24:50 +01:00
core "github.com/Snider/Core"
)
func main() {
app := core.New(
core.WithServiceLock(),
)
wailsApp := application.NewWithOptions(&application.Options{
Bind: []interface{}{app},
})
wailsApp.Run()
2025-10-25 09:24:50 +01:00
}
```
## Services
```go
package demo
import (
core "github.com/Snider/Core"
)
// Register your service
func Register(c *core.Core) error {
return c.RegisterService("demo", &Demo{core: c})
2025-10-25 09:24:50 +01:00
}
```
## Display example
```go
package display
import (
"context"
"github.com/wailsapp/wails/v3/pkg/application"
)
// Open a window on startup
func (d *API) ServiceStartup(ctx context.Context, _ application.ServiceOptions) error {
d.OpenWindow(
OptName("main"),
OptHeight(900),
OptWidth(1280),
OptURL("/"),
OptTitle("Core"),
)
return nil
2025-10-25 09:24:50 +01:00
}
```
See the left nav for detailed pages on each module.