gui/pkg/display/docs/development.md

44 lines
873 B
Markdown
Raw Normal View History

# Development Guide
This guide covers how to set up the development environment, build the project, and run the tests.
## Prerequisites
1. **Go:** Version 1.25 or later.
2. **Node.js & npm:** For building the Angular frontend.
3. **Wails Dependencies:**
- **Linux:** `libgtk-3-dev`, `libwebkit2gtk-4.1-dev`
- **macOS/Windows:** Standard development tools (Xcode Command Line Tools / build-essential).
## Setup
1. Clone the repository and enter the workspace.
2. Install Go dependencies:
```bash
go mod tidy
```
3. Install Frontend dependencies:
```bash
cd ui
npm install
cd ..
```
## Building the Project
### Frontend
```bash
cd ui
npm run build
```
### Backend / Application
This package is exercised through Go tests and the host application that embeds it.
To run the tests:
```bash
go test ./pkg/display/...
```