Packages for building web applications in the Status ecosystem. https://status-components.vercel.app
Go to file
Pavel Prichodko a6fbe36e4d
fix readme formatting
2022-10-10 19:46:50 -05:00
.changeset Use built-in PBKDF2 implementation for browsers (#295) 2022-07-19 17:45:29 +02:00
.github/workflows add release workflow (#293) 2022-07-06 15:05:33 +02:00
.husky Add pre-commit git hooks (#229) 2022-02-24 23:27:22 +01:00
.vscode Update launch.json 2022-09-19 10:47:33 +02:00
examples Add Next.js and Vite examples (#290) 2022-10-10 15:26:44 -05:00
packages v0.1.1 2022-10-09 18:58:52 -05:00
.editorconfig Add editorconfig 2022-02-25 14:56:28 +01:00
.eslintignore Add Activity Center (#312) 2022-10-07 20:02:17 +02:00
.eslintrc Add Next.js and Vite examples (#290) 2022-10-10 15:26:44 -05:00
.gitignore Install `js-waku@^0.25.0` (#307) 2022-09-16 16:27:47 +02:00
.prettierignore Add Next.js and Vite examples (#290) 2022-10-10 15:26:44 -05:00
.prettierrc Improve Prettier monorepo configuration (#225) 2022-02-23 15:49:00 +01:00
LICENSE-APACHE-v2 Update packages to @status-im (#223) 2022-02-23 15:03:14 +01:00
LICENSE-MIT Update packages to @status-im (#223) 2022-02-23 15:03:14 +01:00
README.md fix readme formatting 2022-10-10 19:46:50 -05:00
package.json Install `js-waku@^0.25.0` (#307) 2022-09-16 16:27:47 +02:00
tsconfig.base.json Move to ESM, Vite, Vitest and Turborepo (#286) 2022-06-28 16:40:39 +02:00
turbo.json Setup GitHub Actions (#287) 2022-06-29 16:46:51 +02:00
yarn.lock Add Next.js and Vite examples (#290) 2022-10-10 15:26:44 -05:00

README.md

Status Web 🌐

CI

About

Embeddable, customizable and themable component for your Status Community.

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:

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