24 lines
982 B
Markdown
24 lines
982 B
Markdown
# Superlgos Notifications Module
|
|
|
|
## Introduction
|
|
|
|
The general purpose of the notifications module is providing notification services to other Superalgos Platform modules.
|
|
|
|
## Quick Start
|
|
|
|
Requirements:
|
|
|
|
- NodeJS 8+
|
|
- NPM (comes installed with NodeJS)
|
|
- [Github authorization via SSH](https://help.github.com/articles/connecting-to-github-with-ssh/): *optional* - removes need to authenticate every push or pull from GitHub especially as this is a private repo.
|
|
|
|
1. Clone this repository `git clone https://github.com/AdvancedAlgos/NotificationsModule.git`
|
|
2. `cd NotificationsModule`
|
|
5. Navigate to desired package (eg, server) in /packages and look at its README.md for further instructions.
|
|
|
|
## Getting Started
|
|
|
|
_This repo is currently under heavy initial-phase development and is not representative of the more mature product. On that note, feel free to look around and keep an eye out as the development unfolds!_
|
|
|
|
1. Where we set sail — [to the docs!](./docs/README.md)
|