Packages for building web applications in the Status ecosystem.
https://status-components.vercel.app
b88f7e73da
* setup md/mdx * add test page * setup mdx provider * Add breadcrumbs * links -> routes * add information box * add more remark plugins * text InformationBox * setup contentlayer * add testing docs folder * setup docs static generation * add ssg to blog too * add Shortcut component * add SearchButton * add hook for keyboard shortcuts * update main docs page * update main learn page content * side-bar -> sidebar-menu * rename docs pages * add heading anchors, use new components * add table of contents to docs * move styling to breadcrumbs * cleanup markdown examples * change slugify fn * update getting-started.md * add highlight matches component * update learn pages * rename website InformationBox to Admonition * ?enable user-select * add static helpers to epics * simplify components structure * update insights layout * add link tree utils * add search engine * update docs import * update contenlayer * add docs indexer * support code block highlighting * search index * fix types * remove supporting files * update tree builder * make build work * update docs * update label * update toc * add config.json * update menu * search index import * learn -> help * fix md file * update toc * fix code snippets * add help index route * remove testing files * add original docs * migrate getting started * migrate messaging-and-web3-browser docs * migrate network-nodes-and-statistics docs * handle empty content * add navigation config * wip * migrate status-wallet docs * migrate to new admonitions format * migrate your-profile-and-preferences docs * migrate part of status-communities docs * mv * rm log * index * fix lint * fix warn * fix title * fix docs layout * udpate next.config * use lowercase lang * generate contentlayer types before typechecking * update docs images * update help routes --------- Co-authored-by: Felicio Mununga <felicio@users.noreply.github.com> |
||
|---|---|---|
| .changeset | ||
| .github/workflows | ||
| .husky | ||
| .vscode | ||
| apps | ||
| examples | ||
| packages | ||
| patches | ||
| .editorconfig | ||
| .eslintignore | ||
| .gitignore | ||
| .prettierrc | ||
| LICENSE-APACHE-v2 | ||
| LICENSE-MIT | ||
| README.md | ||
| eas.json | ||
| package.json | ||
| tsconfig.base.json | ||
| turbo.json | ||
| vercel.json | ||
| yarn.lock | ||
README.md
Status Web 🌐
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:
- Open Status Desktop
- Select Community
- Click on its overview in upper left corner
- Invite new people
- Share community
- Get only the public key from the URL (e.g.
0x033c88c950480493e2e759923bd38f9aad88e1b36295757a598679a569e6a96801)
Or create new one first:
- Get Status Desktop at https://status.im/get
- Go to Chat
- Click on plus icon
- 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