Skip to content

vahnag/courier-react

 
 

Repository files navigation

GitHub Workflow Status stability-beta codecov

What is courier-react?

This repository, also called In-App, is a set of features and components that can work inside our customers websites. Courier is a powerful application but integrating all of the features into your frontend manually can be overwhelming and time consuming. This is where In-App steps up and can superpower your application by providing Realtime Messaging (Toast), an Inbox, Notification Preferences, and many more coming soon!

Embedded Integration

Want to use packages with other frameworks/libraries? Check out how to do Embedded Integration

Table of Contents

  1. Contributing
  2. Packages

Packages:

components

This package imports the other react components and bundles them up using webpack and preact to create a bundle that can be used to render all of our components in a frontend that does NOT use React.


react-provider

This package exports a component called CourierProvider which creates a context object that is required for the following packages.


react-toast

Toast is a non modal, component used to display brief, optional-expiring windows of information to a user. This can be integrated with a push provider or can be triggered manually.


react-inbox

Inbox is a component used to display a history of read and unread messages to a user. If we send a message to a user when they are not logged in, or if they didn't interact with the message before it disappeared, we also have an Inbox to show the history of messages received.


react-brand-designer

The "React Brand Designer" package provides components with a slick UI for branding notifications delivered with Courier. This enables your own users to personalize their brand-able notifications like emails without leaving your app or site.


types

Utility package to share common Typescript types and interfaces shared between packages


storybook

Our development environment. This package depends on all the other packages and imports them into a storybook instance. This allows us to develop in an isolated environment.



About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 95.3%
  • JavaScript 2.7%
  • CSS 1.5%
  • Other 0.5%