Add conflict resolution diff UI and app branding
This commit is contained in:
60
README.md
60
README.md
@@ -1,6 +1,6 @@
|
||||
# MD Hub Secure
|
||||
# Cairnquire
|
||||
|
||||
MD Hub Secure is a Go-first documentation platform for serving Markdown as secure, fast HTML with room for later sync, collaboration, and offline features.
|
||||
Cairnquire is a Go-first documentation platform for serving Markdown as secure, fast HTML with room for later sync, collaboration, and offline features.
|
||||
|
||||
## Current Status
|
||||
|
||||
@@ -17,19 +17,23 @@ This repository now contains the Milestone 1 foundation scaffold:
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Go 1.24+
|
||||
- Node.js 24+
|
||||
- npm 11+
|
||||
- `mise`
|
||||
- Docker (optional)
|
||||
- CGO-capable toolchain for `go-libsql`
|
||||
- `air` for Go live reload (`go install github.com/air-verse/air@latest`)
|
||||
- `air` for Go live reload (`go install github.com/air-verse/air@v1.65.1`)
|
||||
|
||||
Install the pinned toolchain with:
|
||||
|
||||
```bash
|
||||
mise install
|
||||
```
|
||||
|
||||
### Development Mode (with live reload)
|
||||
|
||||
Run both the Go server and Vite dev server with live reload:
|
||||
|
||||
```bash
|
||||
make dev
|
||||
mise run dev
|
||||
```
|
||||
|
||||
This starts:
|
||||
@@ -41,10 +45,10 @@ You can also run them separately in two terminals:
|
||||
|
||||
```bash
|
||||
# Terminal 1 - Go server with live reload
|
||||
make dev-server
|
||||
mise run dev-server
|
||||
|
||||
# Terminal 2 - Vite dev server
|
||||
make dev-web
|
||||
# Terminal 2 - Vite dev server
|
||||
mise run dev-web
|
||||
```
|
||||
|
||||
### Production Mode
|
||||
@@ -52,9 +56,9 @@ make dev-web
|
||||
Build the web app and run the Go server without Vite proxy:
|
||||
|
||||
```bash
|
||||
make web-install
|
||||
make web-build
|
||||
make server-run
|
||||
mise run web-install
|
||||
mise run web-build
|
||||
mise run server-run
|
||||
```
|
||||
|
||||
The server listens on `http://localhost:8080` by default.
|
||||
@@ -62,31 +66,31 @@ The server listens on `http://localhost:8080` by default.
|
||||
### Common commands
|
||||
|
||||
```bash
|
||||
make server-test
|
||||
make server-build
|
||||
make docker-build
|
||||
make ci
|
||||
make fmt
|
||||
mise run server-test
|
||||
mise run server-build
|
||||
mise run docker-build
|
||||
mise run ci
|
||||
mise run fmt
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Configuration can come from:
|
||||
|
||||
1. `config.json` via `MD_HUB_CONFIG`
|
||||
1. `config.json` via `CAIRNQUIRE_CONFIG`
|
||||
2. Environment variables
|
||||
|
||||
Supported variables:
|
||||
|
||||
- `MD_HUB_SERVER_ADDR`
|
||||
- `MD_HUB_DATABASE_PATH`
|
||||
- `MD_HUB_DATABASE_PRIMARY_URL`
|
||||
- `MD_HUB_DATABASE_AUTH_TOKEN`
|
||||
- `MD_HUB_CONTENT_SOURCE_DIR`
|
||||
- `MD_HUB_CONTENT_STORE_DIR`
|
||||
- `MD_HUB_WEB_DIST_DIR`
|
||||
- `MD_HUB_DEV_VITE_URL` - Set to proxy `/app/*` to Vite dev server (e.g. `http://localhost:5173`)
|
||||
- `MD_HUB_LOG_LEVEL`
|
||||
- `CAIRNQUIRE_SERVER_ADDR`
|
||||
- `CAIRNQUIRE_DATABASE_PATH`
|
||||
- `CAIRNQUIRE_DATABASE_PRIMARY_URL`
|
||||
- `CAIRNQUIRE_DATABASE_AUTH_TOKEN`
|
||||
- `CAIRNQUIRE_CONTENT_SOURCE_DIR`
|
||||
- `CAIRNQUIRE_CONTENT_STORE_DIR`
|
||||
- `CAIRNQUIRE_WEB_DIST_DIR`
|
||||
- `CAIRNQUIRE_DEV_VITE_URL` - Set to proxy `/app/*` to Vite dev server (e.g. `http://localhost:5173`)
|
||||
- `CAIRNQUIRE_LOG_LEVEL`
|
||||
|
||||
## Noted Gaps
|
||||
|
||||
|
||||
Reference in New Issue
Block a user