https://github.com/theprofs/reporting-service
Node.js RESTful API for all things reporting
https://github.com/theprofs/reporting-service
Last synced: 12 months ago
JSON representation
Node.js RESTful API for all things reporting
- Host: GitHub
- URL: https://github.com/theprofs/reporting-service
- Owner: TheProfs
- Created: 2018-03-22T18:15:47.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-08-13T08:47:03.000Z (almost 8 years ago)
- Last Synced: 2025-03-12T00:44:06.365Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
![][logo]
# reporting-service
> Node.js ReSTful API for all things reporting
[](https://travis-ci.org/TheProfs/reporting-service)
## Installation
```bash
# Install dependencies
$ npm install
```
## Start
This server sends messages to various [Slack][slack] channels. Therefore you
need to obtain a [Slack API Token][slack-token].
Obtain the token and then set it as an environmental variable:
```bash
# Set token
$ export SLACK_TOKEN="xoxp-xxxxxxx-xxxxxxx-xxxxxxx-xxxxxxxxxx"
# Start server
$ npm start
```
## Tests
Make sure the `dev` dependencies are installed and then:
```bash
$ npm test
```
## Authors
- [Nicholas Kyriakides][nicholaswmin]
## Owners
- [The Profs][TheProfs]
## License
The MIT License
## Disclaimers
Project logo is from [icons8.com][icons-8]
[logo]: https://png.icons8.com/nolan/96/000000/report-card.png
[slack]: https://slack.com/
[slack-token]: https://api.slack.com/tokens
[nicholaswmin]: https://github.com/nicholaswmin
[TheProfs]: https://github.com/TheProfs
[icons-8]: https://icons8.com/