kimitzu / kimitzu-client

A web client that interfaces with Kimitzu-Go and Kimitzu-Services
Mozilla Public License 2.0
4 stars 2 forks source link

This project is discontinued.

Kimitzu Client

KIMITZU A Free Market for Services

This repository contains the client to be used with Kimitzu-Go and Kimitzu-Services.

CircleCI

Installation

Snap

kimitzu-client kimitzu-client

Install Kimitzu Client via Snap:

snap install --beta kimitzu-client

Installation Files

Head over to our release page to download the installers according to your platlform.

Tested on:

The installer contains kimitzu-go and kimitzu-services which will automatically run on the background when the client is launched.

Building

Compile kimitzu-go and kimitzu-services first and copy the compiled binaries in the lib folder.

Run npm run build:local to package the binaries and build the client depending on the operating system you use.

Build files can be found on ./build.

Installation files can be found on ./dist.

Running

Using standalone build files

You need to run kimitzu-go and kimitzu-services prior to this.

Run npm run serve. This will host the client on port 3000.

Advanced

For users who want to host their Kimitzu instance remotely, see Installation Instructions for Advanced Users.

Tests

Unit tests: npm run react-test

Automated UI tests: npm run cypress:open

License

This project is licensed under the MIT License. You can view LICENSE.MD for more details.