Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
od41 committed Mar 11, 2024
1 parent 13d773b commit b8cafea
Show file tree
Hide file tree
Showing 6 changed files with 32 additions and 14 deletions.
43 changes: 29 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,49 @@

> This project was bootstrpped with the [!inkathon template](/SETUP.md)
> This project was bootstrpped with the [!inkathon template](/SETUP.md)
---

[![Whisper cover photo](/frontend/public/images/whisper-banner.png)](https://youtube.com)

### Whisper

Whisper is an app where privacy focused individuals can have ephemeral conversations that disappears almost like a whisper, right after they leave.
Whisper is an app where the privacy focused can have ephemeral conversations almost like whispering.

[Live Demo](https://blue-whisper.vercel.app/)


[Video Demo](https://youtube.com/)

## How it works

![Contract flow chart](/frontend/public/images/whisper-user-flow-chart.png)

1. Get some test tokens for Aleph Zero or Accurast
2. Install a wallet([Talisman](https://talisman.xyz/) is a good option)
4. Create or join a chatroom
5. Invite your friends (if you created)
6. Talk and talk
7. Delete chatroom and all messages
3. Create or join a chatroom
4. Invite your friends (if you created)
5. Talk and talk
6. Delete chatroom and all messages

## Usage

![Whisper cover photo](/frontend/public/images/whisper-send-message.gif)

[![Whisper cover photo](https://images.unsplash.com/photo-1576769267415-9642010aa962?q=80&w=1886&auto=format&fit=crop&ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D)](https://youtube.com)
## Components

## Screenshots
Whisper is built for the Polkadot substrate ecosystem, it uses the ink! smart contract language for it's main functionality and a web UI & Talismann wallet for user's interaction with the application.

Lorem ipsum...
Other critical components are:

## Future work
1. !Inkathon: a fullstack boilerplate to build dApps with ink! and on polkadot. I created a [`chatroom` smart contract](/contracts/src/chatroom/lib.rs) which stores the core functionality of the dApp, it was deployed to [Aleph Zero testnet](https://alephzero-testnet.subscan.io/account/5GpiEYmPMVqMcJaR3eeDm4z8a5qZBsAmshYYSCBtuHYa96Bk?tab=transfer) & developer Acurast network.

2. Acurast: users' can create chatrooms that are deployed to the Acurast network. I used the Acurast SDK, created [a hook](/frontend/src/deployments/use-accurast.tsx) that I used to interact with the instance of chatroom on Acurast. The chatoom contract was deployed with the [Acurast console](https://console.acurast.com/job-creation/39)

3. NextJS & useInk: the combination of NextJS and the react library useInk made it trivial [to interact](/frontend/src/context/app-context.tsx) with the chatroom contract.

4. Ink smart contract: I built and tested the chatroom contract with !ink.
![Contract flow chart](/frontend/public/images/whisper-smart-contract-components.png)


## Future Work

Integrate azero.id to have a better UX when sharing messages with each other
Implement e2e encryption

Binary file added frontend/public/images/whisper-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added frontend/public/images/whisper-send-message.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[ZoneTransfer]
ZoneId=3
HostUrl=https://app.clipchamp.com/
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b8cafea

Please sign in to comment.