a6fbe36e4d | ||
---|---|---|
.changeset | ||
.github/workflows | ||
.husky | ||
.vscode | ||
examples | ||
packages | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.gitignore | ||
.prettierignore | ||
.prettierrc | ||
LICENSE-APACHE-v2 | ||
LICENSE-MIT | ||
README.md | ||
package.json | ||
tsconfig.base.json | ||
turbo.json | ||
yarn.lock |
README.md
Status Web 🌐
About
Embeddable, customizable and themable component for your Status Community.
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:
For example, https://status-devcon.vercel.app/.
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
npm install
npm build
Add your Community's public key to your environment:
echo 'PUBLIC_KEY="0x033c88c950480493e2e759923bd38f9aad88e1b36295757a598679a569e6a96801"' >> examples/with-vite/.env
And run it:
npm run dev --workspace=examples/with-vite