Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nextcloud/notifications

:bell: Notifications app for Nextcloud
https://github.com/nextcloud/notifications

hacktoberfest nextcloud nextcloud-app notifications open-source

Last synced: 2 months ago
JSON representation

:bell: Notifications app for Nextcloud

Host: GitHub
URL: https://github.com/nextcloud/notifications
Owner: nextcloud
License: agpl-3.0
Created: 2016-07-01T09:12:17.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-04-14T06:37:04.000Z (8 months ago)
Last Synced: 2024-04-14T10:53:01.485Z (8 months ago)
Topics: hacktoberfest, nextcloud, nextcloud-app, notifications, open-source
Language: PHP
Size: 179 MB
Stars: 107
Watchers: 14
Forks: 53
Open Issues: 41
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: COPYING
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-nextcloud - notifications - Notification app for NC (Apps / Official)

README

# Notifications

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/notifications)](https://api.reuse.software/info/github.com/nextcloud/notifications)

This app provides a backend and frontend for the notification API available in [Nextcloud](https://github.com/nextcloud/server/).
The API is used by other apps to notify users in the web UI and sync clients about various things. Some examples are:

* 📬 [Federated file sharing](https://github.com/nextcloud/server/tree/master/apps/federatedfilesharing): You received a new remote share
* 📑 [Comments](https://github.com/nextcloud/server/tree/master/apps/comments): Another user mentioned you in a comment on a file
* 🚢 [Update notification](https://github.com/nextcloud/server/tree/master/apps/updatenotification): Available update for an app or nextcloud itself
* 📣 [Announcement center](https://github.com/nextcloud/announcementcenter): An announcement was posted by an admin

## Screenshot

![Screenshot of the notification icon and dropdown](https://raw.githubusercontent.com/nextcloud/notifications/master/docs/screenshot.png)

## Developers

### Install and enable the notifications app

- Clone this app into the "apps" folder of your nextcloud instance.
```bash
git clone https://github.com/nextcloud/notifications.git
```

- Enable the app (Log in as the admin into your nextcloud, go to "+ Apps" and search for the "notifications" app to
enable it).

- When you modified the code make sure to execute `make dev-setup` from within the app´s root folder to install develop dependencies and afterwards build the javascript with `make build-js-production`.

### Creating notifications for your app

For information how to make your app interact with the notifications app, see
[Sending and processing/"mark as read" notifications as a Nextcloud App](https://github.com/nextcloud/notifications/blob/master/docs/notification-workflow.md)
in the wiki.

If you want to present notifications as a client, see [Reading and deleting notifications as an Nextcloud Client](https://github.com/nextcloud/notifications/blob/master/docs/ocs-endpoint-v1.md).