GetStream / react-activity-feed

Stream React Activity Feed Components
https://getstream.io/react-activity-feed/
BSD 3-Clause "New" or "Revised" License
137 stars 83 forks source link

Official React SDK for Stream Activity Feed

The official React components for Stream Activity Feed, a service for building activity and notification feed applications.

NPM CI Component Reference

You can sign up for a Stream account at Get Started.

Note: The user interface for the activity feed can vary widely across different apps. Most of our activity feed customers integrate with Stream via their backend and build their own UI. This takes advantage of Stream’s scalability while keeping full control over the UI. This library is only updated and improved sporadically.

:warning: This SDK is no longer actively maintained by Stream

A Feeds integration includes a combination of server-side and client-side code and the interface can vary widely which is why we are no longer focussing on supporting this SDK. If you are starting from scratch we recommend you only use the server-side SDKs.

This is by no means a reflection of our commitment to maintaining and improving the Feeds API which will always be a product that we support.

We continue to welcome pull requests from community members in case you want to improve this SDK.


Install

# with npm
npm install --save react-activity-feed
# with yarn
yarn add react-activity-feed

Usage

To find out how to use this library please look at:

  1. The example project
  2. The component reference docs
  3. This basic example if you just want to see some code:
import { StreamApp, StatusUpdateForm, FlatFeed } from 'react-activity-feed';
import 'react-activity-feed/dist/index.css';

// How to create user tokens: https://getstream.io/activity-feeds/docs/node/auth_and_permissions/?language=javascript#user-tokens

const App = () => {
  return (
    <div style={{ width: '600px', margin: '0 auto' }}>
      <StreamApp apiKey="<YOUR_API_KEY>" appId="<YOUR_APP_ID>" token="<TOKEN_FOR_THE_CURRENT_USER>">
        <StatusUpdateForm />
        <FlatFeed feedGroup="user" notify />
      </StreamApp>
    </div>
  );
};

Internationalisation (i18n)

Please refer to i18n docs

License

BSD-3-Clause © Stream.io Inc.

We are hiring

We've recently closed a $38 million Series B funding round and we keep actively growing. Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.

Check out our current openings and apply via Stream's website.