Giter VIP home page Giter VIP logo

sm446_teamxyz's Introduction

Jarvis (software robot assistant) for corporations [SM446]

The developed software is a Python-based web application(Flask) which acts as an assistant to corporate firms or as an Intelligent Product Manager (IPM). The software’s input interface is a microphone and its output interfaces are a speaker and email. The software provides a voice controlled interface that executes numerous tasks that are carried out in corporate offices on a daily basis.

Technical Details

Abstract Architecture diagram of the project.

Architecture diagram for chat:


Getting Started

Prerequisites

All the dependencies required to run the app are available in reqirements.txt.

The application also requires a Redis server for session storage.

You can choose a hosted service for the requirement, or you can choose to host it yourself. Download link and hosting information is available at the following links:

The application also requires a browser and python(>3) to function. Python can be downloaded from link, installation instructions are also provided at the link.

Installing

To install the dependencies:

  1. Navigate to backend directory
  2. Open a terminal and enter pip3 install -r requirements.txt

Deployment

To start the backend service:

  1. Navigate to backend directory.
  2. Create a file with the name .env
  3. Add the following lines of code
SECRET_KEY=
REDIS_URL=
  1. Set the variables (there should be no space after '='). SECRET_KEY can be any randomly generated string. REDIS_URL give the URL's to the Redis services respectively.
  2. Start the server with flask run

To host the frontend:

  1. Navigate to frontend directory.
  2. Open a terminal and run python3 -m http.server. By default the service will start on port 8000.
  3. Navigate to http://localhost:8000/jarvis.html to access the bot.

Built With

  • Python - The software is based on Python.
  • Javascript - Additionally it also uses Javascript.
  • Atlassian APIs:
    • JIRA API - Used to access and execute tasks on the JIRA board.
    • Bitbucket API - Used to access the company’s Bitbucket repository.
    • Confluence API - Used to access and execute tasks on the Confluence board.
  • Gmail API - Used to access and send the company’s email.
  • Web Speech API - Used for speech recognition and speech to text.
  • Redis - Used for session management.
  • Rasa - A chatbot framework used to understand, interpret end-user queries and appropriately fetch response data over REST and scraping.
  • Flask - It is a python micro-framework which will be used to provide a web interface.

Authors

Team XYZ:

  • Shritej Patil
  • Jamaluddin Khan
  • Pooja More
  • Nikunj Gaonkar
  • Om Rao
  • Rohit Kadam

Mentors:

  • Tanmay Gujar
  • Dylan Dsouza

License

This project is licensed under the Apache-2.0 License - see the LICENSE.txt file for details.

Acknowledgments

sm446_teamxyz's People

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.