Update README
This commit is contained in:
57
README.md
57
README.md
@@ -13,11 +13,20 @@ A client-side web linking tool for mapping relationships between entities.
|
||||
- Share link via base64 for smaller graphs
|
||||
- Undo/Redo support
|
||||
- PWA support (installable, offline-capable)
|
||||
- Self-hostable
|
||||
- Desktop App support (via Wails)
|
||||
- Single Binary Web Server (via Go)
|
||||
- Mobile support
|
||||
|
||||
## Self-Hosting
|
||||
|
||||
### Go Binary
|
||||
|
||||
The easiest way to self-host is using the single binary:
|
||||
|
||||
```sh
|
||||
./linking-tool --port 8080
|
||||
```
|
||||
|
||||
### NPM
|
||||
|
||||
```sh
|
||||
@@ -25,23 +34,23 @@ npm config set @quad4:registry https://git.quad4.io/api/packages/quad4-software/
|
||||
npm install -g @quad4/linking-tool
|
||||
linking-tool
|
||||
```
|
||||
Or
|
||||
|
||||
```sh
|
||||
PORT=3000 HOST=0.0.0.0 linking-tool
|
||||
```
|
||||
### Docker
|
||||
|
||||
```sh
|
||||
docker run -p 3000:3000 git.quad4.io/quad4-software/linking-tool
|
||||
docker run -p 8080:8080 git.quad4.io/quad4-software/linking-tool
|
||||
```
|
||||
|
||||
### Podman
|
||||
## Desktop Application
|
||||
|
||||
You can build the desktop application for your platform using Wails:
|
||||
|
||||
```sh
|
||||
podman run -p 3000:3000 git.quad4.io/quad4-software/linking-tool
|
||||
make desktop-build
|
||||
```
|
||||
|
||||
The binary will be located in `bin/`.
|
||||
|
||||
## Development
|
||||
|
||||
```sh
|
||||
@@ -49,31 +58,29 @@ git clone https://git.quad4.io/quad4-software/linking-tool.git
|
||||
cd linking-tool
|
||||
```
|
||||
|
||||
### NPM
|
||||
|
||||
```sh
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Makefile
|
||||
|
||||
```sh
|
||||
make dev
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
Uses Chainguard Images which are rootless and very minimal images.
|
||||
The project uses a Makefile for all common tasks:
|
||||
|
||||
```sh
|
||||
docker build -t quad4-linking-tool .
|
||||
docker run -p 3000:3000 quad4-linking-tool
|
||||
make dev # Run development servers (Go & SvelteKit)
|
||||
make build # Build the single binary web server
|
||||
make help # List all available targets
|
||||
```
|
||||
|
||||
### Docker Build & Artifact Extraction
|
||||
|
||||
If you don't have the development environment (Go, Node, Wails) installed locally, you can build and extract binaries using Docker:
|
||||
|
||||
```sh
|
||||
make docker-builder
|
||||
```
|
||||
|
||||
This will build the server and desktop application inside a container and copy the resulting binaries to the `bin/` directory on your host machine.
|
||||
|
||||
## Contributing
|
||||
|
||||
Send us a email at[team@quad4.io](mailto:team@quad4.io) for any issues or feedback.
|
||||
Send us an email at [team@quad4.io](mailto:team@quad4.io) for any issues or feedback.
|
||||
|
||||
## LICENSE
|
||||
|
||||
|
||||
Reference in New Issue
Block a user