/myna

Automate all the things

Primary LanguageElixirMIT LicenseMIT

🦜 Myna

Myna CI

Just another slack bot.

🚩This is not working at all right now, everyting is WIP.

📒 Table of Contents

🔧 Installation

If available in Hex, the package can be installed by adding myna to your list of dependencies in mix.exs:

def deps do
  [
    {:myna, "~> 0.1.0"}
  ]
end

📖 Documentation

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/myna.

✨ Usage

TODO: termporary env variable setup, this only works at compile time, so need to pull configuration in a differnt way before deploying/distributing.

export MYNA_SLACK_TOKEN="xxxxxxxx"

🧪 Testing

Test Locally

Commands require a publically accessible call back. You can set up ngrok to get a public URL and get requests tunneled to your localhost.

  1. Create a free account at ngrok.com

  2. Follow the setup instructions

  3. ... TODO: more steps reg ports etc

✅ Pre-Commit

How to setup git pre-commit hooks to keep this project nice and clean:

  1. Install pre-commit if it is not yet installed.
  2. Run 
    pre-commit install

ℹ️ You can regularly upgrade the existing commit hooks to the latest verion by running:

pre-commit autoupdate