Skip to content

Embeddable, customizable and themable component for your Community.

License

Notifications You must be signed in to change notification settings

njiddasalifu/status-web

This branch is 201 commits behind status-im/status-web:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

1866ca8 Β· Jun 13, 2023
Jul 19, 2022
Apr 26, 2023
Feb 24, 2022
May 29, 2023
Jun 13, 2023
May 29, 2023
Jun 13, 2023
Apr 26, 2023
Feb 25, 2022
May 16, 2023
May 3, 2023
May 16, 2023
Feb 23, 2022
Feb 23, 2022
Feb 23, 2022
Nov 17, 2022
Feb 10, 2023
May 16, 2023
May 16, 2023
May 16, 2023
May 12, 2023
Jun 13, 2023

Repository files navigation

Status Web 🌐

CI

About

Embeddable, customizable and themable component for your Status Community.

Who

  • For community leaders
  • online content creators
  • and their followers

What

  • It is 100% open source
  • 100% decentralized
  • Peer-to-peer
  • Private
  • Pseudoanonymous
  • End-to-end encrypted
  • Free
  • Permissionless
  • Serverless
  • Group chat platform
  • And a virtual space outside the jurisdiction of any government

Why

  • To communicate and collaborate freely without worrying about
    • Censorship
    • Persecution
    • Chilling effects
    • Interference
    • Oppression
    • Being deplatformed, or shut down
  • Support
    • Autonomy
    • Free speech
    • Freedom of association
    • Freedom to transact
    • Right to privacy
    • Crypto native and frictionless integration
    • Monetization
    • Facilitation of sharing of common interests, needs, desires and values
  • Be trusted alternative to centralized group chat application

Usage

For Community owners πŸ‘₯

Get public key to your pre-existing Community:

  1. Open Status Desktop
  2. Select Community
  3. Click on its overview in upper left corner
  4. Invite new people
  5. Share community
  6. Get only the public key from the URL (e.g. 0x033c88c950480493e2e759923bd38f9aad88e1b36295757a598679a569e6a96801)

Or create new one first:

  1. Get Status Desktop at https://status.im/get
  2. Go to Chat
  3. Click on plus icon
  4. Click on Communities

Use the Community component:

In your project,

Install package:

npm install @status-im/react

Import component:

import { Community } from '@status-im/react'

Set component props:

<Community
  publicKey="0x033c88c950480493e2e759923bd38f9aad88e1b36295757a598679a569e6a96801"
  theme="light"
/>

For an example, see examples/with-vite/src/app.tsx.

For User πŸ‘€

Simply visit your Community's URL from the browser:

If the Community doesn't require a joining request, that would be it. So look around and get the feel for the space.

Once ready to chat, create a throwaway profile:

Use Throwaway Profile > wait for your request to be approved and the chat input enabled > react to and write messages

Optionally, you could even run the application locally yourself.

Get the source ready:

git clone https://github.com/status-im/status-web.git
cd ./status-web
yarn install
yarn run build

Add your Community's public key to your environment:

echo 'PUBLIC_KEY="0x033c88c950480493e2e759923bd38f9aad88e1b36295757a598679a569e6a96801"' >> examples/with-vite/.env

And run it:

yarn workspace with-vite run dev

About

Embeddable, customizable and themable component for your Community.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.5%
  • Other 1.5%