bitbucket-notifier

README

Bitbucket Notifier

Get toast-notifications natively through your linux install for relevant activity on the Pull Requests relevant for you from your Bitbucket server. Customize *what* to show and **when** it should show.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• Golang
• Notify-send
• Bitbucket API
• Resty
• Crypto
• Term
• Net
• Sys
• go-yaml

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Package Manager

  sudo apt install notify-send
  

Installation

1. Clone the repo :)

   git clone https://github.com/sifterstudios/bitbucket-notifier
   

(back to top)

Usage

Download repo, build, and run. Needs to be run from /cmd directory currently.

On first run, you will be prompted to input your options and credentials. This will be saved to a config file(encrypted). Please note, this is only a semi-secure solution as the key for the decryption is also made and available inside the /data folder.

Although both the secretkey and the config file is ignored in the .gitignore file, and therefore won't automatically be pushed, it's important to be aware of this as a potential security risk.

I only made the credentials encrypted to not accidentally show that info when browsing the files.

After adding credentials and info, the frontend should be available at http://localhost:1337 and enables you to choose more customization of how and when you want to be notified, as well as how often to check.

And that's pretty much it!

Information about how to run this automatically on startup will follow in the future.

(back to top)

Roadmap

See the open issues for a list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @sifterstudios

Project Link: https://github.com/sifterstudios/bitbucket-notifier

(back to top)