# MewsFeed Specs

[](https://hackmd.io/DSAyoLf1TbWpDwTZNcTrOg)

## ⚠ DEPRECATED ⚠
This document is **deprecated**. The source-of-truth for project management of MewsFeed is now on github: https://github.com/orgs/GeekGene/projects/1

## Background

During the early days of Holochain development in 2016 and 2017, members of the team decided to try building MVPs of commonly used platforms on the prototype version of Holochain. Among those was a Twitter clone we called "Clutter," themed around cats instead of birds (because cats eat birds). And because a Clutter or Clowder is the groupname for a bunch of cats. It worked well enough to play with at hackathons, and give occasional demos, but never became a full-featured affair.


When we rebuilt Holochain in Rust, we rebooted Clutter in Rust too, but didn't give it much attention or many features beyond basic mews/tweets.

Then one of our newly hired team members, ([Jost](https://github.com/jost-s)), wanted to take on a learning project of building an app, and rebuilt Clutter on the latest, industrial strength version of Holochain, and slowly started adding more features in his spare time.

Now that Musk has thrown Twitter into chaos, and we have figured out some critical features that no microblogging platforms are doing yet, it may be time to take on this project in earnest and get it taken seriously as an alternative to Twitter.

In this spirit, we are christening it with its new name that may have broader appeal.

Welcome to your MewsFeed.

## Key Benefits and Differences
So, what makes MewsFeed better than the alternatives?
- **Fully Peer-to-Peer (P2P):** Most systems are still centralized, or run on inefficient and costly blockchains. [Secure Scuttlebutt](https://scuttlebutt.nz) has been building a great P2P social messaging community for years. The main advantage to P2P is that you truly own and hold your own data, and control your keys and identity. And you are not dependent on corporate servers which surveil you to sell your personal data to advertisers.
- **Agent-Centric:** Most

[Mastodon](https://mastodon.social)
[nostr](https://github.com/nostr-protocol/nostr)
[Secure Scuttlebutt](https://scuttlebutt.nz)
[Farcastr]
[Hive]
[Counter.social]
[Post.news]
[Diaspora]
[Peach]
[Parler]
[Truth.social]
[Gab]
[Cohost]
[Tumblr]

## MewsFeed v0.1: the Cappuccino (TBC) Release
Think "Basic Twitter" feature match...

The first major release of MewsFeed is the Cappuccino (TBC) Release. It features a basic microblogging capacity, user profiles, replies, mentions, likes, hashtags & cashtags, and more.

#### Profile Zome
- [x] Register a username
- [x] Enforce minimum length of 3 characters
- [x] Create / Edit user profile
- [x] Display name / full name
- [x] Upload avatar image
- [x] Basic 1-line bio
- [x] Location
- [x] View a User Page
- [x] View their Mews
- [x] See their Followers
- [x] See who they're Following
- [ ] Button/Link to find @user mentions
- [x] Follow / Unfollow users (by agentkey on their page)
- [x] Follow Button/Action
- [x] Unfollow Button/Action
- [x] Change username
- [x] Process tweet text for grammatical components
- [x] @user mentions
- [x] #hashtags
- [x] $cashtags ?
- [x] ^links (in UI triggers a link constructor)
- [x] Combined Search for:
- [x] users (by username/pathname/anchor) with three character autocomplete
- [x] Enforce lower case username search matching
- [x] #hashtags
- [x] $cashtags

#### Mews Zome
- [x] Compose/Commit mew
- [x] View your Mews Feed (with recent mews from follows)
- [x] show avatar
- [x] show username
- [x] show full/display name
- [x] Link new mew from a agentkey as a post
- [x] Reply to mew :left_speech_bubble:
- [x] ReMew (Retweet without comment) :recycle:
- [x] QuoteMew (Retweet with comment)
- [x] Lick/Like a mew :heart: :tongue:
- [ ] Delete a mew (mark as deleted) 🗑

#### Specialized UI Components
- [ ] HomePage / Dashboard
- [ ] #HomePage (10 latest uses of this tag)
- [ ] Link/Button to browse user profiles
- [x] On Hover Previews
- [x] Profile Pic: user info summary
- [x] Mention inside a Mew: user info summary

## MewsFeed v0.2: the Othello (TBC) Release
Think "becoming something new and different"...

The second major release of MewsFeed is the Othello (TBC) Release. It adds [NomDeNet](https://nomde.net) integration, the MewsFeed zome for use in other apps, mews syndication, yarn spinning,

- [ ] Enable username registration (via NomDeNet) as a revenue model, and to manage disambiguated ownership of names

**Dashboard / Home Page UI**
- [ ] Newest Name Registrations (via Nom)
- [ ] "Trending" hashtags / cashtags / mentions

**Profile Zome**

**Mews Zome**
- [ ] Open social preview (e.g. thumbnail, mewmew box, etc) [mattyg was working on this]
- [ ] Pagination + infinite scroll on feed pages (meaning we get_link the full set of hashes but only retrieve the mew contents page by page)
- [ ] Attach / Upload Picture (maybe use [open-dev file sharing zome](https://github.com/holochain-open-dev/file-storage))
- [ ] Enforce 4mb size limit (UI should auto-scale down images above it)

**Profiles**
- [ ] Disambiguation page for usernames
- [ ] Differentiating identicon with avatar to prevent masquerading

## The MewsFeed Zome
If you are building a Holochain App that could use a microblogging feature, you can integrate the MewsFeed zome. You get out-of-the-box posts, likes, replies, retweets, quote tweets, and profiles.

Ready to get some cat-themed tweety goodness into your app? Get in touch!

## The MewsFeed hApp

## The Holo-hosted MewsFeed Website
https://mewsfeed.social

## Assumptions & Intentions
- Reuse some of the original crazy cat stuff for UI, but have support for different skins (crazy LOLcat & other more toned down options like more vanilla light & dark themes)
- Our goal is to have a competent, show-worthy app, that doesn't have to be perfect, but should also expose some agent-centric data-sync behaviors in the UI.
- We'd like to end up with something that people would enjoy playing with and would be good to talk about amidst the drama of Musk's Twitter exodus.
- Demonstrate agent-centric content moderation contexts via participation protocols
- Enable portable micro-blogging functionality for "We" app, and have "MewsFeed" be the syndication/publishing channel to wider public via "portal" DNA.
- Reuse some existing open source widgets / UIs where possible?

## Architecture
The basic idea of MewsFeed is the following:
1. a microblogging hApp library ("the MewsFeed library") available for inclusion in "We" and other hApps across the ecosystem,
2. a hApp and social media site ("the MewsFeed site") available for content from within those other hApp contexts to be syndicated to via a portal DNA

## Ideas

- Can't have coherence without membranes
- Can't have coherence without a functional space
- Syndication outbox (set default to "spill" or "stay")
- Participation protocol
- When I'm out in MewsFeed land, stuff I do there should not flow into my groups where the MewsFeed library is being used for micro-blogging

### We

- Creating a collaborative space
- Discussion threads, collaborative editing, micro-blogging

#### Namespaces and Mastodon Translation
Name Types
- Users --> AgentPubKey (NomNoms)
- Orgs --> Multiple Agents in Roles (OrgNoms)
- Syndicated Contexts --> DNAhash for bridging queries via Portal DNA

Name looks like: `[NameTypePrefix]_[Name]` (reference ActivityPub documentation for allowed characters in usernames)

## Basic Feature List
### 1st Pass / MVP for playing (mostly complete)

### Later Passes / Future Features
- [x] Preview Profile
- [ ] **sPin a Yarn** (feature unique to clutter)
- [ ] Limit N pinned yarns (2?)
- [ ] Threaded / Git/branching view for yarn
- [ ] $cashtag transaction accounting
- [ ] tx grammar
- [ ] accounting nodes
- [ ] Update Post
- [ ] Language preference in user profile
- [ ] Future: Search mews by keywords
- [ ] Direct Messages
- [ ] Lists??

## User Experience / Workflow

## UI Specs

### Pages
- [ ] Home page: TBD
- [ ] Trending / Active Mews
- [ ] Trending / Active Yarns
- [ ] Trending / Active C/Hashtags?
- [ ] Links to help/docs/support?
- [x] User page
- [x] View/Edit my profile:
- [x] View/Follow other user profile
- [x] Un/follow button
- [ ] Preview user mews
- [ ] Pinned Yarns
- [x] Mews_by(agent)
- [ ] MewsFeed(agent): collated mews_by from the people the agent follows
- [ ] pagination for MewsFeeds
- [ ] Mews which are part of a yarn have an icon/link to view source yarn
- [ ] Yarns threads / gitbranch view

## DNA Specs

### Component DNAs

#### MewsFeed App

###### Entry Defs

###### External FnsAttach image / file store

**V.01 / First Pass**

Zome: Profile
- create_handle(string)
- create_profile(struct)
- update_profile(struct)
- view_user()

#### Contents / Structure of MewsFeed

Date sorted Vector of FeedMews

enum MewType {
  Original(MewContent,
  Reply(HeaderHash,MewContent),
  ReMew(HeaderHash,Option<MewContent>),
  MewMew(HeaderHash,MewContent), // QuoteTweet
}

struct FullMew {}
  mew_type: MewType,
  mew: Option<MewContent>,
}

struct MewContent {
  mew: String, // "Visit this web site ^link by @user about #hashtag to earn $cashtag! Also read this humm earth post ^link (as an HRL link)" 
  mew_links: Vec[LinkTypes], // [^links in the mewstring in sequence]
  mew_images: Vec[EntryHash], //Vec of image links hashes to retrieve
}
enum LinkTypes {
  URL,
  HRL, //Holochain Resource Locator DnaHash/DhtHash<@AgentKey>
}

struct AuthorInfo {
 handle: Profile.handle,
 full_name: Profile.Firstname + Profile.Lastname,
 avatar_hash: EntryHash,
}

struct FeedMew {
  author: AuthorInfo,
  time: Element.Header.TimeStamp,
  mew: FullMew,
  stats: Vec[u32], // counts of get_links for replies, retweets, likes
}

MewsFeed: Vec[FeedMews]

### Structuring Links in MewsFeed

Use PATHS for a bunch of stuff to find things in standard places. For example:

/agent/[sharded agent_pubkey]/mews/ (links to mews)
                      /followers (links to agentkeys)
                      /following (links to agentkeys)
                      /licks (likes) (links to mews)
                      /mentions (links to mews)
                      /images (links to entryhashes)
/hashtag/[sharded hashtag] (links to mews)
/cashtag/[sharded cashtag] (links to mews)
/handle/[rivalrously managed namespace]/[links to agentkeys]
/time/year/month/day/hour/

Other non-path links

MewContent/replies
          /retweets
          /licks(likes)

enum FeedOptions {
    By(AgentPubKey),
    About(Path), // (mentions, hashtags, cashtags, links)
    FollowedBy(AgentPubKey), 
    authored_by: AgentPubKey
    
}

Paths
/hashtags/[tags]
/cashtags/[tags]
/agents/[agentpubkey][3:2]
  .../mentions
  .../favorites
  .../following
  .../follows

Zome: Mews
- create_mew()
- view_mew // includes replies (and related things, e.g. "quote tweets")
- mews_feed(FeedOptions) -> Vec<Mew>
- mews_by(AgentPubKey)
- reply_to_mew()

**Future versions**
Zome: Profile
- delete_handle() // leave the platform
- update_handle(string)
- preview_profile()
Zome: Mews
- delete_post()
- update_post()

#### Keyword Indexer (someday)
###### Entry Defs
###### External Fns

#### Personas/profiles (someday)

## Mimetic Content / Branding
- Cattiness
- Cat = animal of the internet
- Mew instead of tweet
- Mewmew instead of retweet
- Mewsfeed instead of newsfeed
- Licks instead of likes
- Collar tags instead of username/handle
- ## editors

## Possible Versions with bad Cat Puns
1. A - Alpaw / Apawling release
2. B - Biter /
3. C -
4. D -
5. E -

### Catty word bases for puns
[400+ Cat words](https://relatedwords.io/cat)
- Cat Catty Kit Kitty Meow Mew Lick Fur Furry Hiss Spit Groom Clutter/Cludder/Clowder Purr Pounce Tom Tomcat Play Yowl Catcall
- [Cat Puns](https://whiskerstotailspetsitting.com/2017/05/purr-fect-list-cat-vocabulary-not-kitten-around/)
-

## Possible Versions Named after Philosophers
1. Anaxagoras - introduced the concept of *Nous* (Cosmic Mind) from which we get the idea of the noosphere
2. B...
3. Heraclitus

/.idea
/.vscode

## system files
.DS_Store
## editors
/.idea
/.vscode

## system files
.DS_Store