Skip to content

README.rst

Latest commit

 

History

History
93 lines (61 loc) · 2.77 KB

README.rst

File metadata and controls

93 lines (61 loc) · 2.77 KB
Raw

frontend-app-notifications

License status-badge Continuous Integration Codecov

Purpose

This repository hosts @openedx/frontend-app-notifications, the Open edX notifications frontend app. It is consumed by sites built on @openedx/frontend-base and contributes a notifications bell widget to the unified header's desktop and mobile right slots.

Getting Started

Installation

Install the package into a site that uses @openedx/frontend-base:

npm install @openedx/frontend-app-notifications

Then register the app's default export alongside the other App configs in your site.config.*.tsx:

import notificationsApp from '@openedx/frontend-app-notifications';
import { shellApp, headerApp, footerApp } from '@openedx/frontend-base';

const config: SiteConfig = {
  // ...
  apps: [shellApp, headerApp, footerApp, notificationsApp],
};

export default config;

Named exports (NotificationsTray, Notifications, useAppNotifications, useNotification) remain available for consumers that embed the tray or its hooks directly.

Local Development

Clone this repository and install dependencies:

npm install

Run the bundled dev site (shell + header + footer + this app):

npm run dev

To develop against a local frontend-base checkout, bind-mount it into the workspace and run the packages-aware dev script. See the Makefile for the dev-packages and bin-link targets.

License

The code in this repository is licensed under the AGPLv3 unless otherwise noted.

Please see LICENSE for details.

Contributing

Contributions are welcome. Please open an issue or pull request on GitHub.

People

Contact @edx/edx-infinity if you are having any trouble developing in this repository.

Reporting Security Issues

Please do not report security issues in public. Email security@openedx.org instead.