https://github.com/willis7/golossary

A chatbot for storing and retrieving words relating to a specific subject, text, or dialect, with explanations
https://github.com/willis7/golossary

chatbot glossary go golang slack-bot

Last synced: about 1 year ago
JSON representation

A chatbot for storing and retrieving words relating to a specific subject, text, or dialect, with explanations

• Host: GitHub
• URL: https://github.com/willis7/golossary
• Owner: willis7
• License: mit
• Created: 2017-03-19T14:38:45.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-18T21:10:48.000Z (about 9 years ago)
• Last Synced: 2025-04-13T17:00:02.608Z (about 1 year ago)
• Topics: chatbot, glossary, go, golang, slack-bot
• Language: Go
• Size: 24.4 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# golossary

[![Build Status](https://travis-ci.org/willis7/golossary.svg?branch=master)](https://travis-ci.org/willis7/golossary)

[![Coverage Status](https://coveralls.io/repos/github/willis7/golossary/badge.svg?branch=master)](https://coveralls.io/github/willis7/golossary?branch=master)

A chatbot for storing and retrieving words relating to a specific subject, text, or dialect, with explanations

## Run the application

```

git clone git@github.com:willis7/golossary.git

cd golossary

make docker-build

make docker-run

```

## Architecture

TODO

```

         +----------------+        

         |   Message      |        

         |   Dispatcher   |        

         +----------------+        

            /          \           

           /            \          

          /              \         

         /                \        

        /                  \       

+-----------+         +-----------+

| Performer |         | Performer |

|           |         |           |

+-----------+         +-----------+

```

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## Credits

Golossary uses a number of open source projects to work:

* [Gorilla] - Provides an implementation for the WebSocket protocol defined in RFC 6455.

* [Viper] - Complete configuration solution for go applications including 12 factor apps.

## License

MIT

[Gorilla]: http://www.gorillatoolkit.org/pkg/websocket#ReadJSON

[Viper]: https://github.com/spf13/viper