M D N Search Bot

by Fazendaaa

GitHub Readme.md

MDN Search Docs Bot

A Telegram bot that searches the Mozilla Developer Network website.



Say Thanks!

English README Portuguese README

Build Status Coverage Status Maintainability Known Vulnerabilities

About

A simple way of searching MDN content through Telegram.

Disclaimer

By default all the commands are in English, but you can see if que same command is available in your language.

How to use it

First of all, talk to @mdnsearchbot.

Sending Documentation

The inline mode works in any chat conversation:

@mdnsearchbot content to be searched

Example:

@mdnsearchbot Array

Help

If you have any other questions about it just use it the help command:

/help

How does it work?

You can build yourself a bot similar to this one, I've wrote a tutorial about it in my Podesearch Bot just follow the procedures listed in BUILDING.md.

Deployment

This bot is up and running at Heroku through the Github integration, that means that each new push to the master branch means that is the code serving the bot. You can see more about how does it run at the server by looking at the Procfile. You can also deploy yourself this bot into Heroku through:

Deploy

Build with

Artwork

I've made all the artwork for it:




Contributing

Please, I'm not a native/fluent english speaker, so whether you see a variable name wrote the wrong way or even some comment where I've wrote something with the wrong "past perfect way of life" or something like that, please let me know it. Not always is just about the code, but rather making it more clear to other people to learn from it.

So, whether is code or not you can help me out making this code more accessible by reading the CONTRIBUTING.md.

Versioning

I would love to say that SemVer or anything like that is used but, in my personal experience, this kind of approach doesn't work very well with me, the guy who could be committing in this project for two weeks in a roll and leave it for almost one year with no simple npm update. So, no versioning system is used.

Testing

There's a Travis CI integration and I've written all the testing with Jest.

Code

Plain and simple Typescript and the Microsoft linter standards for it.

Contributing

Just talk to me through opening a issue.

Versioning

Just using plain and simple npm version. See the badge at the top of this readme.

TODO

Since I will be keeping this README up to date with any major change and I don't use any versioning system to log all the fixed bugs or previous projects updates, you can still have a taste of what comes next and what is being under analysis right in the Projects tab.

Authors

  • Only me for now.

Consider buy me a coffee:

Buy Me a Coffee

Or even becoming a patron:

Patreon

License

Like many Open-Source Software (OSS) the MIT license is used, more about it in LICENSE.