Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lithika-damnod/russ

Get instant answers to your questions about any text with Russ - an AI-powered reading companion that analyzes and summarizes any text you provide and answer questions based on the information in the passage
https://github.com/lithika-damnod/russ

chatgpt react saas text-analysis text-summarization ui ux

Last synced: 23 days ago
JSON representation

Host: GitHub
URL: https://github.com/lithika-damnod/russ
Owner: lithika-damnod
License: agpl-3.0
Created: 2023-01-18T11:50:02.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2023-02-07T03:31:31.000Z (almost 2 years ago)
Last Synced: 2023-03-09T05:46:10.062Z (almost 2 years ago)
Topics: chatgpt, react, saas, text-analysis, text-summarization, ui, ux
Language: JavaScript
Homepage: https://russ-chatgpt.netlify.app
Size: 854 KB
Stars: 12
Watchers: 3
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

Get instant answers to your questions about any text with Russ - an AI-powered reading companion that analyzes and summarizes any text you provide and answer questions based on the information in the passage

View Demo
·
Documentation
·
Report Bug
·
Request Feature

# :notebook_with_decorative_cover: Table of Contents

- [About the Project](#star2--about-the-project)
- [What is Russ ? ](#question-what-is-russ-)
- [Tech Stack](#space_invader--tech-stack)
- [Usage](#triangular_flag_on_post--usage)
- [Getting Started](#toolbox--getting-started)
- [.env File Format](#key--environment-variables)
- [Run Locally](#running--run-locally)
- [FAQ](#grey_question-faq)
- [License](#warning--license)
- [Contact](#handshake--contact)

## :star2: About the Project

### :question: What is Russ ?

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.

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

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

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

1. 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.

### :space_invader: Tech Stack

### :triangular_flag_on_post: Usage

> #### :eye: Head over to https://russ-chatgpt.netlify.com

#### * Click on "Try It" button for more options

#### Options :arrow_upper_right:

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.

#### :drop_of_blood: Option: Typing / Pasting

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.

1. 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".

1. 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.

1. 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.

#### :drop_of_blood: Option: Image Scan

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.

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

1. 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".

1. 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.

## :toolbox: Getting Started

### :key: Environment Variables

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`

### :running: Run Locally

Clone the project

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

Go to the project directory

```bash
cd Russ
```

Install dependencies

```bash
yarn install
```

Start the server

```bash
yarn start
```

## :grey_question: FAQ

- 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.

## :warning: License

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

## :handshake: Contact

> Email: [email protected]