README
¶
Burnout Barometer is a Slack tool to log, track, and assess you or your team's stress and work-life.
Want to get started? Download the burnout barometer or just:
Highlights
- Track your emotional state straight from Slack
- Log events are stored and tracked in Postgres or BigQuery
- Easy to set-up and deployable in a severless fashion (Cloud Run, FaaS, etc.)
Learn more about this project in the documentation!
Contributing
This project is open for contributors! Contibutions can come in the form of feature requests, bug fixes, documentation, tutorials and the like! We highly recommend to file an Issue first before submitting a Pull Request.
Simply fork this repository and make a Pull Request! We'd definitely appreciate:
- Implementation of new features
- Bug Reports
- Documentation
- Testing
Be sure to check our Contribution Guidelines before starting.
License
MIT License, Copyright (c) 2020 Lj Miranda
Documentation
¶
Overview ¶
Burnout Barometer is a simple Slack tool to log, track, and assess you or your team's stress and work life.
Installation ¶
You can get the barometer executable from the Releases page: https://github.com/ljvmiranda921/burnout-barometer/releases. Binaries are available for Windows, Linux, and MacOS operating systems with amd64 architecture.
Alternatively, you can build your own binary from source by cloning the repository and compiling it. The following steps work for Go 1.11 and above:
$ git clone git@github.com:ljvmiranda921/burnout-barometer.git $ cd burnout-barometer $ go get $ go build .
Burnout Barometer is a server-side application, and can be deployed by various means. You can also check out our Docker image located in the Azure Container Registry. For deployment options, head over this link: https://ljvmiranda921.github.io/burnout-barometer/installation/#deployment-options
Usage ¶
You can find usage instructions for Burnout Barometer in our external documentation: https://ljvmiranda921.github.io/burnout-barometer/usage/
Contributing ¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. Simply fork the Github repository and make a Pull Request. We're open to any kind of contribution, but we'd definitely appreciate (1) implementation of new features (2) writing documentation and (3) testing.
License ¶
MIT License (c) 2020, Lester James V. Miranda
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd contains all commands in the burnout-barometer CLI.
|
Package cmd contains all commands in the burnout-barometer CLI. |
|
function
module
|
|
|
Package pkg contains types and methods for interacting with the barometer.
|
Package pkg contains types and methods for interacting with the barometer. |