Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alisdair/team-time-zone-backend
Authentication server for Team Time Zone
https://github.com/alisdair/team-time-zone-backend
Last synced: 10 days ago
JSON representation
Authentication server for Team Time Zone
- Host: GitHub
- URL: https://github.com/alisdair/team-time-zone-backend
- Owner: alisdair
- License: mit
- Created: 2015-07-06T17:05:34.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-25T18:56:44.000Z (over 7 years ago)
- Last Synced: 2024-10-12T20:57:11.652Z (24 days ago)
- Language: JavaScript
- Homepage: https://github.com/alisdair/team-time-zone
- Size: 3.91 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Team Time Zone backend
This is a simple [Express.js][express] app which provides the authentication API for [Team Time Zone][ttz]. The only endpoint is `/api/tokens`, which implements the second stage of the [Slack OAuth2 Web Authentication Flow][slack-oauth].
[express]: http://expressjs.com
[ttz]: https://github.com/alisdair/team-time-zone
[slack-oauth]: https://api.slack.com/docs/oauth## Installation
Clone the repository, then run `npm install`.
## Deployment
You'll need to configure your [Slack application keys][slack-app] to use this yourself. Store these on your server in a `.env` file, using the format given in `.env.example`. You can also use this file to change the port that Express listens on.
[slack-app]: https://api.slack.com/applications
[The Ember app][ttz] expects the token endpoint at `/api/tokens` on the same domain it is served from, so you will probably need to set up a proxy to do that. How you do so depends on your web server.
## To-do List
* [ ] Add integration tests with [Nock][nock]
* [ ] More documentation on deployment
* [ ] Better error handling[nock]: https://github.com/pgte/nock