Code Monkey home page Code Monkey logo

aklilu-mandefro / askme Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 9.0 1.42 MB

askMe is a chatbot app that you can ask any type of questions in a specific area of expertise and deep dive into that so that you can master it by asking as many questions as you want.

Home Page: https://askme-chatbot.vercel.app/

License: MIT License

HTML 5.37% JavaScript 24.40% PHP 3.48% CSS 66.75%
chatbot-application intelligent-systems javascript-app javascript-applications askme

askme's Introduction

askMe

askMe is a chatbot app that you can ask any type of questions in a specific area of expertise and deep dive into that so that you can master it by asking as many questions as you want.

Areas that the chatbot is well-versed:

  1. Research
  2. Computer
  3. Health and medicine
  4. Law
  5. Games
  6. Music
  7. Sport
  8. Art
  9. Investment
  10. Environment
  11. Animation
  12. Law
  13. Nutrition
  14. General (one chatbot is expert in everything)

Tech-stacks Used

  • Vanilla Javascript
  • Open AI
  • Chat GPT 3.5
  • HTML5
  • CSS3 and
  • A little PHP ( but optional)

Installation

  1. Create your API Key on the openAI website: https://platform.openai.com/account/api-keys

img

  • To store your api key, you have 2 options

    1. Using a key on the frontend: You can put your API Key in a json file, without the need to use a server.
    • The advantage is that you don't need a server.
    • The disadvantage is that your API KEY is exposed, and other people can see it.
      Then access the file.json file (html-files/json/config.json) and put your key in the API_KEY field between the quotes
      img
    1. Using a key on the backend: The second option, you can use a php file to store your key, so your key will be protected on the server
      To use this option, you must set the "use_php_api" field to true in the config.json file.
      Note: To use this option you will need a host with PHP 7 or higher



    After modifying the config.json file, also modify the php file with your key


  1. Configure your environment

    The CORS (Cross-Origin Resource Sharing) is a security measure that browsers implement to protect users against malicious attacks that can occur when a website attempts to access resources from another site. In other words, CORS is a security policy that browsers use to prevent a site from accessing information from another site without authorization.
    When you try to run the index.html file locally and it makes a request to another file such as config.json, the browser may prevent the request from being completed due to the CORS security policy. This is because the browser is trying to protect you against possible malicious attacks.
    To solve this problem, it is recommended to run the application on a local server on your machine such as WAMP, XAMPP or similar. Alternatively, you can upload the application to your website using FTP.

    After configuring your environment, you can access index.html in your browser and test
    img

Badwords

In the config.json file you can define if you want to use a filter for badwords.
This filter is great if you want to prevent the user from typing certain words in the chat.

(In config.json: "filter_badwords": true)
You can change list of badwords in json/badwords.json file.

Issues

If you find an error while installing or using this app, kindly visit the Discussion or create an issue.

Contribute to this project

Thank you for browsing this repo. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

Please give this repo a โญ if you found it helpful.

askme's People

Contributors

aklilu-mandefro avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

askme's Issues

Multilingual Support

You can contribute to this project by adding new features that can make the app better. But, here is one as a starting point ๐Ÿ‘‡:

  1. Expand the chatbot's capabilities to support multiple languages, allowing users from different regions to interact with it in their native tongues.

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.