View Demo · Documentation · Report Bug · Request Feature

• About the Project
  • What is Russ ?
  • Tech Stack
  • Usage
• Getting Started
  • .env File Format
  • Run Locally
• FAQ
• License
• Contact

Russ is an AI-powered reading companion app that can analyze and summarize any text you provide and answer questions based on the information in the text. Its use cases include:

1. Quick understanding: You can quickly understand the main ideas of a long text by using Russ.

2. Education: Students can use Russ to quickly summarize and understand complex academic readings.

3. Research: Researchers can use Russ to quickly summarize large amounts of information and identify relevant details.

4. Knowledge acquisition: Anyone can use Russ to learn and acquire knowledge from any text they are reading.

5. Time-saving: With Russ, you can save time by quickly getting the information you need from a text, instead of having to read it all.

👁️   Head over to https://russ-chatgpt.netlify.com

• Image Scan: The first input method is scanning text from an image. In this method, users can take a picture of the text they want to analyze and summarize, and the app will use optical character recognition (OCR) technology to extract the text from the image and make it available for analysis.
• Typing / Pasting: The second input method for the AI-powered reading companion app, "Russ," is typing or pasting the text into a text area. Users can either type the text directly into the app or paste a previously copied text into the text area.

1. Input Passage: Type or paste the text you want to analyze into the text area provided. Russ is ready to unlock the secrets of any text, no matter how long or complex it may be.

2. Ask Questions: After inputting your passage, it's time to ask questions! Simply type your question into the "Ask a Question" field and hit "See Answer".

3. Get Instant Answers: With the power of AI, Russ provides instant answers to your questions based on the information in the passage. Say goodbye to hours of tedious reading and hello to lightning-fast insights and understanding.

4. Expand Your Understanding: If you need more information or would like to dive deeper into a specific aspect of the text, simply ask another question. Russ is always ready to help you understand and remember what you've read.
   
   

   

1. Upload Image: Drag and drop or select an image file of the text you want to analyze. Russ uses cutting-edge optical character recognition (OCR) technology to extract the text from the image for analysis.
   
   

2. Verify Text: Review the extracted text to make sure it is correct. If any errors are present, simply make the necessary corrections.
   
   

3. Ask Questions: Just like typing or pasting text, you can now ask questions about the text. Simply type your question into the "Ask a Question" field and hit "See Answer".

4. Get Instant Answers: With the power of AI, Russ provides instant answers to your questions based on the information in the image text. Say goodbye to hours of tedious reading and hello to lightning-fast insights and understanding.

5. Expand Your Understanding: If you need more information or would like to dive deeper into a specific aspect of the text, simply ask another question. Russ is always ready to help you understand and remember what you've read.
   
   

To run this project, you will need to add the following environment variables to your .env file

REACT_APP_OPENAI_API_KEY

REACT_APP_GOOGLE_ANALYTICS_TRACKING_ID

Clone the project

  git clone https://github.com/lithika-damnod/Russ.git

Go to the project directory

  cd Russ

Install dependencies

  yarn install

Start the server

  yarn start

• What is Russ?

  • Russ is an AI-powered reading companion that analyzes and summarizes any text you provide and answers questions based on the information in the passage.

• How do I use Russ?

  • You can use Russ by typing or pasting text into the app or by scanning text from an image. Simply input your text, ask a question, and hit "See Answer" to get instant answers based on the information in the text.

• Does Russ work with all types of text?

  • Russ works with all types of text, including lengthy articles, complex documents, and even scanned images.

• Is Russ accurate?

  • Russ uses advanced AI algorithms via OpenAI's API to provide accurate answers to your questions. However, it is still important to verify the information obtained through Russ against other sources.

• How does Russ extract text from an image?

  • Russ uses optical character recognition (OCR) technology from Tesseract.js to extract text from an image. This allows you to analyze and understand text that is not available in a digital format.

• Can I ask multiple questions about the same text?

  • Yes, you can ask multiple questions about the same text and get instant answers to each one.

Distributed under the AGPL-3.0 License, See LICENSE.txt for more information.

Email: l.d.b.dasanayaka@gmail.com