Skip to content

Holochain App: Completely distributed Twitter alternative

Notifications You must be signed in to change notification settings

pegaltier/clutter

 
 

Repository files navigation

Clutter is now MewsFeed

We are currently working towards the first major release of MewsFeed.

Collaborate on GitHub and join our Discord: https://discord.gg/D3BykUZumM

Environment Setup

  1. Install the holochain dev environment (only nix-shell is required): https://developer.holochain.org/quick-start/

  2. Clone this repo and cd inside of it.

  3. Enter the nix shell by running this in the root folder of the repository:

nix-shell
npm install

This will install all the needed dependencies in your local environment, including holochain, hc and npm.

5. Install git submodule dependency (ui-common-library)

# not necessary with this Angular fork
git submodule init
git submodule update --remote --recursive

Building the DNA

  • Build the DNA (assumes you are still in the nix shell for correct rust/cargo versions from step above):
npm run build:happ

Running the DNA tests

npm run test

UI

To test out the UI:

npm start

To run another agent, open another terminal, and execute again:

npm start

Each new agent that you create this way will get assigned its own port and get connected to the other agents.

Package

To package the web happ:

npm run package

You'll have the clutter.webhapp in workdir. This is what you should distribute so that the Holochain Launcher can install it.

You will also have its subcomponent clutter.happ in the same folder`.

Documentation

We are using this tooling:

Refactored with Nx/Angular/Ionic

Preview

  • Angular Webapp

Preview of Clutter web

  • Ionic Mobileapp

Preview of Clutter mobile

Nx

npx nx@latest init
npm install --save-dev @nrwl/angular
npx nx generate @nrwl/angular:application clutter-web --no-interactive
npm install --save-dev --exact @nxtend/ionic-angular --legacy-peer-deps
npm install --save-dev --exact @nxtend/capacitor --legacy-peer-deps
npx nx generate @nxtend/ionic-angular:application clutter-mobile --capacitor false
npx nx generate @nrwl/angular:library clutter/data-access-dna
npx nx generate @nrwl/angular:library shared/util-holochain
npx nx generate @nrwl/angular:library shared/util-common

WSL

# start wsl session & start deamon as root: https://nixos.org/manual/nix/stable/installation/multi-user.html
wsl
sudo su -
nix-daemon
# start another wsl session and enjoy your nix commands
wsl
nix develop --extra-experimental-features nix-command --extra-experimental-features flakes

About

Holochain App: Completely distributed Twitter alternative

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 46.2%
  • Vue 28.5%
  • SCSS 9.9%
  • Rust 7.7%
  • HTML 5.9%
  • JavaScript 1.0%
  • Other 0.8%