https://github.com/data-fair/notify
A simple server to manage notifications feeds for our users. Notifications are stored and pushed to various channels.
https://github.com/data-fair/notify
Last synced: 4 months ago
JSON representation
A simple server to manage notifications feeds for our users. Notifications are stored and pushed to various channels.
- Host: GitHub
- URL: https://github.com/data-fair/notify
- Owner: data-fair
- License: agpl-3.0
- Created: 2019-11-07T14:58:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-22T08:10:01.000Z (about 1 year ago)
- Last Synced: 2025-04-22T09:24:51.098Z (about 1 year ago)
- Language: JavaScript
- Size: 3.64 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# notify
A simple server to manage notifications feeds for our users. Notifications are stored and pushed to various channels.
## Sponsors
| | Click [here to support the development of this project](https://github.com/sponsors/koumoul-dev). |
|-|-|
| [
](https://koumoul.com) | [Koumoul](https://koumoul.com) develops the Data Fair ecosystem and hosts it as an online service. |
| [
](https://dawizz.fr) | [Dawizz](https://dawizz.fr) uses the Data Fair ecosystem inside its platform and supports its development. |
## Development
```
npm run dev-eps
sh scripts/init.sh
npm run dev-client
npm run dev-server
docker compose exec router sh -c "mongo < /scripts/init-sharding.js"
```
When both servers are ready, go to [http://localhost:5994](http://localhost:5994) and chose an account in `test/resources/users.json` to login with its email and password.
A large part of the functionalities are intended to be integrated as iframes. Check these pages:
- [managing the user's devices](http://localhost:5994/embed/devices)
- [overview of the user's subscription](http://localhost:5994/embed/subscriptions)
- [subscribe to an organization's events as a member](http://localhost:5994/embed/subscribe?key=topic1&title=Topic1&sender=organization:orga1)
- [subscribe to an organization's events as a member with specific role](http://localhost:5994/embed/subscribe?key=topic1&title=Topic1&sender=organization:orga1::admin)
- [subscribe to an organization's events as a department member](http://localhost:5994/embed/subscribe?key=topic1&title=Topic1&sender=organization:orga2:dep1)
Run test suite:
```
npm run test
```
Test building the docker image:
```
docker build -t notify-dev .
```