From 694c08af7dbcf2798999a51a53521041a32d897b Mon Sep 17 00:00:00 2001 From: kelvin-omoh <95302653+kelvin-omoh@users.noreply.github.com> Date: Sun, 5 Mar 2023 19:02:50 +0100 Subject: [PATCH] Updated this JAVRIS README.md docs --- README.md | 91 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 59 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 1700d2df..5f9d8e06 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,21 @@ # JARVIS on Messenger + +[![Build Status](https://travis-ci.org/swapagarwal/JARVIS-on-Messenger.svg?branch=master)](https://travis-ci.org/swapagarwal/JARVIS-on-Messenger) +![Python](https://img.shields.io/badge/python-2.7-blue.svg) +[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/) +[![Gitmoji](https://img.shields.io/badge/gitmoji-%20🚀%20🐳-FFDD67.svg)](https://gitmoji.carloscuesta.me) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/swapagarwal/JARVIS-on-Messenger/master/LICENSE) +[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/swapagarwal/JARVIS-on-Messenger?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Contributors](https://img.shields.io/github/contributors/swapagarwal/JARVIS-on-Messenger.svg)](https://github.com/swapagarwal/JARVIS-on-Messenger/graphs/contributors) +[![Beginner Issues](https://img.shields.io/github/issues/swapagarwal/JARVIS-on-Messenger/Low-Hanging%20Fruit.svg?label=low-hanging%20fruits)](https://github.com/swapagarwal/JARVIS-on-Messenger/labels/Low-Hanging%20Fruit) +[![Pull Requests Closed](https://img.shields.io/github/issues-pr-closed/swapagarwal/JARVIS-on-Messenger.svg)](https://github.com/swapagarwal/JARVIS-on-Messenger/issues?q=is%3Apr+is%3Aclosed) -Just A Rather Very Intelligent System, now on Messenger! + # Introduction +Now available on Messenger, Just A Very Very Intelligent System (JAVRIS) aims to enhance communication and support job automation. +1.2 billion people use Messenger each month as of now. Bots are ready to [take](http://time.com/4291214/facebook-messenger-bots/) [over](http://www.computerworld.com/article/3055588/social-media/an-army-of-chatbots-will-take-over-facebook-here-s-why.html). + with the introduction of Send/Receive API. + + + +### Why? -### Usage - -JARVIS is at your service [here](https://m.me/J.A.R.V.I.S.on.Messenger). - -Buy Me A Coffee -Become a Patron! + JARVIS was created with two goals in mind: -### Demo (Vimeo) +1. To have lot's of useful features (both fun and commonly used). +1. Making it scalable and dynamic will enable participation in this project. Anyone with a working grasp of Python can contribute because this is module-based.) This project's main objective is to make it easier to enter the open source community. - - JARVIS on Messenger Demo - -### Why? +Take a look at the [contributing guidelines](https://github.com/swapagarwal/JARVIS-on-Messenger/blob/master/CONTRIBUTING.md) to see how easy it is to add your own code. I'll be waiting for your pull request! :wink: -I created JARVIS with two goals in mind: +A massive Thank You to all [contributors](https://github.com/swapagarwal/JARVIS-on-Messenger/graphs/contributors), and congratulations to people who made their first open-source contribution! :tada: -1. It should have a lot of useful features (both fun and commonly used). -1. Anyone can contribute to this project. (As this is module-based, anybody with a decent knowledge of Python can contribute.) One of the prime goals of this project is to lower the entry barrier into the world of open source. + +### Demo -Take a look at the [contributing guidelines](https://github.com/swapagarwal/JARVIS-on-Messenger/blob/master/CONTRIBUTING.md) to see how easy it is to add your own code. I'll be waiting for your pull request! :wink: + A short video of how its used on Mesenger -A massive Thank You to all [contributors](https://github.com/swapagarwal/JARVIS-on-Messenger/graphs/contributors), and congratulations to people who made their first open-source contribution! :tada: + + JARVIS on Messenger Demo + ### Modules @@ -87,23 +100,28 @@ More sample queries can be found [here](https://github.com/swapagarwal/JARVIS-on ### Local Development / Testing 1. Clone this repo. -2. Linux: +1. Operating system + - Linux: a) Debian (Ubuntu, Linux Mint, etc.): `sudo apt-get install python-dev libffi-dev libssl-dev` b) Arch Linux: `sudo pacman -S python2 libffi openssl` c) Fedora: `sudo yum install python-devel libffi-devel openssl-devel` -Windows: These should already be pre-installed in your Python bundle. -Mac/OS X: + - Windows: These should already be pre-installed in your Python bundle. + - Mac/OS X: a) If you install Python using brew, the relevant headers are already installed for you. In other words, you don't need python-devel. -b) `brew install pkg-config libffi` -`export PKG_CONFIG_PATH=/usr/local/Cellar/libffi/3.0.13/lib/pkgconfig/` # May change with libffi version -`pip install cffi` -c) `brew install libtins` -3. `pip install -r requirements.txt` +b)Install brew ```brew install pkg-config libffi``` ```export PKG_CONFIG_PATH=/usr/local/Cellar/libffi/3.0.13/lib/pkgconfig/` # May change with libffi version ``````pip install cffi``` +c) ```brew install libtins``` + +3. Install module requirements +``` +pip install -r requirements.txt +``` 4. `python jarvis.py` 5. Visit the following URLs to see results: `http://localhost:5000/process/?q=<>` returns the intent of the query. `http://localhost:5000/search/?q=<>` returns the search result of the query. + + ![result](/images/result_hello.png) ![result](/images/result_joke.png) @@ -115,20 +133,29 @@ c) `brew install libtins` > You can mock the results for local testing by adding your queries [here](https://github.com/swapagarwal/JARVIS-on-Messenger/blob/master/local/wit.json). * The "search" endpoint returns the actual bot output, which you get when you interact with the bot using that query. -Note that for the search query to work, you have to set your own key (of the module that you want to test) in config.py +Note that for the search query to work, you have to **set your own key** (of the module that you want to test) in config.py If you want a public endpoint, use the below button to deploy on Heroku and fill the relevant API keys that you would like to use: [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) + +### Usage + +JARVIS is at your service [here](https://m.me/J.A.R.V.I.S.on.Messenger). + +Buy Me A Coffee +Become a Patron! + + ### TL;DR for Beginners -1. J.A.R.V.I.S. runs on Python 2 -1. For the search query to work, you have to set your own key (of the module that you want to test) in config.py -1. The best place to ask anything: https://gitter.im/swapagarwal/JARVIS-on-Messenger -1. Some issues are reserved for you! https://github.com/swapagarwal/JARVIS-on-Messenger/labels/Low-Hanging%20Fruit -1. If you're working on something, let everyone know by either creating an issue or commenting on an existing one so that work is not duplicated. -1. Prefer using an IDE (Use [PyCharm](https://www.jetbrains.com/pycharm/download/) if you don't have any preference yet) +- J.A.R.V.I.S. runs on Python 2 +- For the search query to work, you have to set your own key (of the module that you want to test) in config.py +- The best place to ask anything: https://gitter.im/swapagarwal/JARVIS-on-Messenger +- Some issues are reserved for you! https://github.com/swapagarwal/JARVIS-on-Messenger/labels/Low-Hanging%20Fruit +- If you're working on something, let everyone know by either creating an issue or commenting on an existing one so that work is not duplicated. +- Prefer using an IDE (Use [PyCharm](https://www.jetbrains.com/pycharm/download/) if you don't have any preference yet) ### History