server

command module
v0.0.0-...-d44ee03 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 26, 2024 License: MIT Imports: 19 Imported by: 0

README

natricon backend

CI Twitter Follow

The backend and business logic for natricon

natricon is built in GOLang

Requirements

The natricon backend requires ImageMagick development libraries to be installed. ImageMagick should be compiled with librsvg, libxml2, libpng, and libwebp.

Natricon server build setup

# install dependencies
$ go get -u
# run in debugging mode
$ go run .

# build binary for production
$ go build . -o natricon
# execute natricon in production mode
$ GIN_MODE=release ./natricon

# For all options run
$ ./natricon -help

WebAssembly (wasm) build setup

There is a WebAssembly reference implementation in the wasm folder

This allows you to generate a natricon entirely on client-side from within the browser.

# To compile wasm
$ cd wasm
$ GOOS=js GOARCH=wasm go build -o main.wasm

# Running the sample
$ go get -u github.com/go-serve/goserve
$ ${GO_PATH}/bin/serve .

Other Server Configuration

The server implements some mechanisms for tracking donations, such as a socket.io server and subscription to nano node websocket.

The account to listen for donations can be set in the environment

export DONATION_ACCOUNT=nano_1natrium1o3z5519ifou7xii8crpxpk8y65qmkih8e8bpsjri651oza8imdd

The websocket can be setup by specifying it as a parameter

./natricon -node-ws-url http://[::1]:7078

The website uses raw amounts to identify donations with specific clients and implements an automatic refund mechanism, to use this the WALLET_ID should be specified in the environment. For either Pippin or the Nano Node Wallet

export WALLET_ID=d897b5ec-1897-4e7e-8a90-4526f454c8de

All of these settings are optional, and don't need to be specified for the natricon server to run.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
wasm module

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL