elemental-chat-ui

License:

Vue based user interface for elemental-chat DNA

For dev testing:

Install these as per their READMEs:
Now you can fire everything up with a few commmands:

General setup:

install the deps: yarn install
enter into nix-shell: nix-shell
setup one of the following environments:

holochain environment:

In a terminal window, install and configure the happs for 2 agents: yarn hc:gen-agents 2a. Thereafter, in the same window, run the dna for agent 1: yarn hc:run-agent-1 2b. Optionally, in a second window run the dna for agent 2: yarn hc:run-agent-2 3a. After the command from step 2 completes, serve the UI for agent 1: yarn serve:hc-agent-1 3b. Optionally, in the corresponding terminal for agent 2, serve the UI for agent 2: yarn serve:hc-agent-2

holo host (self-hosted) environment:

In a terminal window, install and configure the happs for the host agent: yarn hc-host:gen-agent
Thereafter, in the same window, run the dna for the host agent: yarn hc-host:run
After the command from step 2 completes, serve the UI for the host agent: yarn serve:self-hosted

holo hosting web environment:

In a terminal window, spin up your the holo-dev-server- a binary of combined Envoy-Chaperone development servers: yarn run:holo
- If this is your first time running the server, you will first need to install and unwrap the binary and necessary happs. To do so, run: yarn fetch:resources
- NB: When using this dev binary, you will connect to chaperone and envoy, but circumvent the resolvers to assign a host.
In a new terminal window, serve the UI for the host agent in the same terminal window: yarn serve:holo

When you're done and you want to clean up all holochain databases that hc created in /tmp, run one of the following depending on your prior context:

holochain: yarn clear:hc && yarn clear:lair
holo host (self-hosted): yarn clear:hc && yarn clear:lair
holo-hosted web user: yarn clear:hc-holo

Other environment variables

VUE_APP_HIDE_ADD_CHANNEL

Setting this to VUE_APP_HIDE_ADD_CHANNEL=true before running a serve or build command will hide the "add channel" button in the ui.

How to run automated tests:

All tests

yarn test

Unit tests

For the holochain environment yarn test:unit-hc
For the holo environment yarn test:unit-holo

Integration tests

For the holochain environment yarn test:integration-hc
For the holo environment yarn test:integration-holo

Build:

For holochain context:

yarn run build-holochain

For self-hosted context:

yarn run build-self-hosted

For production holo-hosted context:

yarn run build-holo-hosted

For development holo-hosted context:

yarn run build-holo-dev

For test holo-hosted context:

build-holo-scale-test

Self-hosted release:

Edit scripts/release-builds.sh for correct DNA id
Run: scripts/release-builds.sh
Create release on github and upload created .zip artifacts
Edit release URL value in holo-nixpkgs and create branch
Test on holoport after hydra builds

Publish Maintenance page

To replace the EC UI with a maintenance page, you first have to setup the wrangler cli (which requires cloudflare access). Then run

yarn install
yarn publish:maintenance-page

Contribute

Holochain is an open source project. We welcome all sorts of participation and are actively working on increasing surface area to accept it. Please see our contributing guidelines for our general practices and protocols on participating in the community, as well as specific expectations around things like code formatting, testing practices, continuous integration, etc.

Connect with us on our forum

License

This program is free software: you can redistribute it and/or modify it under the terms of the license provided in the LICENSE file (CAL-1.0). This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

EarthlingJim / elemental-chat-ui