{"id":22174017,"url":"https://github.com/lithika-damnod/russ","last_synced_at":"2025-09-07T01:33:07.964Z","repository":{"id":65725361,"uuid":"590427540","full_name":"lithika-damnod/Russ","owner":"lithika-damnod","description":"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","archived":false,"fork":false,"pushed_at":"2023-02-07T03:31:31.000Z","size":874,"stargazers_count":22,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-26T10:04:37.895Z","etag":null,"topics":["chatgpt","collaborate","react","saas","text-analysis","text-summarization","ui","ux"],"latest_commit_sha":null,"homepage":"https://russ-chatgpt.netlify.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lithika-damnod.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"lithika","open_collective":"lithika-damnod","ko_fi":"lithikadamnod","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2023-01-18T11:50:02.000Z","updated_at":"2025-02-04T09:19:14.000Z","dependencies_parsed_at":"2023-02-19T11:16:07.522Z","dependency_job_id":null,"html_url":"https://github.com/lithika-damnod/Russ","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/lithika-damnod/Russ","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lithika-damnod%2FRuss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lithika-damnod%2FRuss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lithika-damnod%2FRuss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lithika-damnod%2FRuss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lithika-damnod","download_url":"https://codeload.github.com/lithika-damnod/Russ/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lithika-damnod%2FRuss/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273986612,"owners_count":25202704,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chatgpt","collaborate","react","saas","text-analysis","text-summarization","ui","ux"],"created_at":"2024-12-02T07:36:32.903Z","updated_at":"2025-09-07T01:33:07.931Z","avatar_url":"https://github.com/lithika-damnod.png","language":"JavaScript","funding_links":["https://patreon.com/lithika","https://opencollective.com/lithika-damnod","https://ko-fi.com/lithikadamnod","https://www.buymeacoffee.com/lithikadamnod"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\" width=\"100%\"\u003e\n\u003cimg src=\"https://user-images.githubusercontent.com/61654812/213165180-cb365b58-ebd6-48fd-a205-b73e0be94d60.png\" width=\"250\" /\u003e\n\u003c/p\u003e\n\u003ch3 align=\"center\" \u003e\nGet 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\n\u003c/h3\u003e\n\u003ch1\u003e\u003c/h1\u003e\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/github/last-commit/lithika-damnod/Russ/develop/app?style=for-the-badge\"\u003e\n\u003cimg src=\"https://img.shields.io/github/v/release/lithika-damnod/Russ?include_prereleases\u0026style=for-the-badge\"\u003e\n\u003cimg src=\"https://img.shields.io/website?style=for-the-badge\u0026url=https%3A%2F%2Fruss-chatgpt.netlify.app%2F\"\u003e\n\u003cimg src=\"https://img.shields.io/github/stars/lithika-damnod/Russ?style=for-the-badge\"\u003e\n\u003cimg src=\"https://img.shields.io/github/license/lithika-damnod/Russ?style=for-the-badge\"\u003e\n\u003ch4\u003e\n    \u003ca href=\"https://russ-chatgpt.netlify.app\"\u003eView Demo\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"#triangular_flag_on_post--usage\"\u003eDocumentation\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://github.com/lithika-damnod/Russ/issues\"\u003eReport Bug\u003c/a\u003e\n  \u003cspan\u003e · \u003c/span\u003e\n    \u003ca href=\"https://github.com/lithika-damnod/Russ/issues\"\u003eRequest Feature\u003c/a\u003e\n\u003c/h4\u003e\n\u003c/div\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n\n\u003c!-- Table of Contents --\u003e\n\n# :notebook_with_decorative_cover: \u0026nbsp; Table of Contents\n\n- [About the Project](#star2--about-the-project)\n  - [What is Russ ? ](#question-what-is-russ-)\n  - [Tech Stack](#space_invader--tech-stack)\n  - [Usage](#triangular_flag_on_post--usage)\n- [Getting Started](#toolbox--getting-started)\n  - [.env File Format](#key--environment-variables)\n  - [Run Locally](#running--run-locally)\n- [FAQ](#grey_question-faq)\n- [License](#warning--license)\n- [Contact](#handshake--contact)\n\n\u003cbr\u003e\n\u003c!-- About the Project --\u003e\n\n## :star2: \u0026nbsp; About the Project\n\n### :question: What is Russ ?\n\nRuss 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:\n\n1. \u003cb\u003eQuick understanding:\u003c/b\u003e You can quickly understand the main ideas of a long text by using Russ.\n\n1. \u003cb\u003eEducation:\u003c/b\u003e Students can use Russ to quickly summarize and understand complex academic readings.\n\n1. \u003cb\u003eResearch:\u003c/b\u003e Researchers can use Russ to quickly summarize large amounts of information and identify relevant details.\n\n1. \u003cb\u003eKnowledge acquisition:\u003c/b\u003e Anyone can use Russ to learn and acquire knowledge from any text they are reading.\n\n1. \u003cb\u003eTime-saving:\u003c/b\u003e With Russ, you can save time by quickly getting the information you need from a text, instead of having to read it all.\u003c!-- TechStack --\u003e\n\n\u003cbr\u003e\n\n### :space_invader: \u0026nbsp; Tech Stack\n\n\u003cul\u003e\n\u003ca href=\"https://reactjs.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/React-20232A?style=for-the-badge\u0026logo=react\u0026logoColor=61DAFB\"\u003e\u003c/a\u003e\u003c/li\u003e\n\u003ca href=\"https://www.framer.com/motion/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Framer Motion-20232A?style=for-the-badge\u0026logo=Framer\"\u003e\u003c/a\u003e\u003c/li\u003e\n\u003ca href=\"https://mui.com/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Material UI-20232A?style=for-the-badge\u0026logo=MUI\"\u003e\u003c/a\u003e\u003c/li\u003e\u003cbr\u003e\n\u003ca href=\"https://openai.com/api/\"\u003e\u003cimg src=\"https://img.shields.io/badge/OpenAI API-20232A?style=for-the-badge\u0026logo=OpenAI\"\u003e\u003c/a\u003e\u003c/li\u003e\n\u003ca href=\"https://react-redux.js.org/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Redux-20232A?style=for-the-badge\u0026logo=Redux\"\u003e\u003c/a\u003e\u003c/li\u003e\n\u003ca href=\"https://www.npmjs.com/package/axios\"\u003e\u003cimg src=\"https://img.shields.io/badge/Axios-20232A?style=for-the-badge\u0026logo=Axios\"\u003e\u003c/a\u003e\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cbr\u003e\n\n### :triangular_flag_on_post: \u0026nbsp; Usage\n\n\u003e #### :eye: \u0026nbsp; Head over to https://russ-chatgpt.netlify.com\n\n\u003cbr\u003e\n\n#### * Click on \"Try It\" button for more options\n\n#### Options \u0026nbsp; :arrow_upper_right:\n\n\u003cul\u003e\n  \u003cli\u003e\n    \u003cb\u003eImage Scan:\u003c/b\u003e 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. \n  \u003c/li\u003e\n  \u003cli\u003e\n    \u003cb\u003eTyping / Pasting:\u003c/b\u003e 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.\n  \u003c/li\u003e\n\u003c/ul\u003e\n\u003ckbd\u003e\n  \u003cimg src=\"https://user-images.githubusercontent.com/61654812/216918328-53995e1e-24be-49fa-b89d-427f7a75ce72.gif\" alt=\"russ more options demo\"\u003e\n\u003c/kbd\u003e\n\n\u003cbr\u003e\n\n#### :drop_of_blood: \u0026nbsp; Option: Typing / Pasting\n\n1. \u003cb\u003eInput Passage:\u003c/b\u003e 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.\n\n1. \u003cb\u003eAsk Questions:\u003c/b\u003e After inputting your passage, it's time to ask questions! Simply type your question into the \"Ask a Question\" field and hit \"See Answer\".\n\n1. \u003cb\u003eGet Instant Answers:\u003c/b\u003e 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.\n\n1. \u003cb\u003eExpand Your Understanding:\u003c/b\u003e 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.\n   \u003cbr\u003e\n   \u003cbr\u003e\n   \u003ckbd\u003e\n   \u003cimg src=\"https://user-images.githubusercontent.com/61654812/217037651-2e70e949-a245-4aa8-a63b-d1dd96e9ef73.gif\" alt=\"russ typing / pasting demo\"\u003e\n   \u003c/kbd\u003e\n   \u003c!-- visit sri lanka banner --\u003e\n   \u003ca href=\"https://www.touropia.com/tourist-attractions-in-sri-lanka/\"\u003e\n     \u003cdiv align=\"right\"\u003e\n       \u003cimg src=\"https://user-images.githubusercontent.com/61654812/217004075-26614b78-b8c4-4c35-b5ea-9a35bafc7c82.png\" width=\"60%\" alt=\"#VisitSriLanka\"\u003e\n     \u003c/div\u003e\n   \u003c/a\u003e\n\n#### :drop_of_blood: \u0026nbsp; Option: Image Scan\n\n1. \u003cb\u003eUpload Image:\u003c/b\u003e 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.\n   \u003cbr\u003e\n   \u003cbr\u003e\n   \u003ckbd\u003e\n   \u003cimg src=\"https://user-images.githubusercontent.com/61654812/217043543-d66cd827-1b1a-4f68-adde-65823775cf45.gif\" alt=\"russ image scan input demo\"\u003e\n   \u003c/kbd\u003e\n\n1. \u003cb\u003eVerify Text:\u003c/b\u003e Review the extracted text to make sure it is correct. If any errors are present, simply make the necessary corrections.\n   \u003cbr\u003e\n   \u003cbr\u003e\n   \u003ckbd\u003e\n   \u003cimg src=\"https://user-images.githubusercontent.com/61654812/217046464-de59efb2-6fa9-4460-9440-489394abd1ec.gif\" alt=\"russ image scan text verify demo\"\u003e\n   \u003c/kbd\u003e\n\n1. \u003cb\u003eAsk Questions:\u003c/b\u003e 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\".\n\n1. \u003cb\u003eGet Instant Answers:\u003c/b\u003e 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.\n\n1. \u003cb\u003eExpand Your Understanding:\u003c/b\u003e 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.\n   \u003cbr\u003e\n   \u003cbr\u003e\n   \u003ckbd\u003e\n   \u003cimg src=\"https://user-images.githubusercontent.com/61654812/217045520-5414cd17-4fa7-42c1-9c11-320231803735.gif\" alt=\"russ image scan text answering questions\"\u003e\n   \u003c/kbd\u003e\n\n\u003cbr\u003e\n\u003c!-- Getting Started --\u003e\n\n## :toolbox: \u0026nbsp; Getting Started\n\n\u003c!-- Env Variables --\u003e\n\n### :key: \u0026nbsp; Environment Variables\n\nTo run this project, you will need to add the following environment variables to your .env file\n\n`REACT_APP_OPENAI_API_KEY`\n\n`REACT_APP_GOOGLE_ANALYTICS_TRACKING_ID`\n\n\u003c!-- Run Locally --\u003e\n\n### :running: \u0026nbsp; Run Locally\n\nClone the project\n\n```bash\n  git clone https://github.com/lithika-damnod/Russ.git\n```\n\nGo to the project directory\n\n```bash\n  cd Russ\n```\n\nInstall dependencies\n\n```bash\n  yarn install\n```\n\nStart the server\n\n```bash\n  yarn start\n```\n\n\u003cbr\u003e\n\u003c!-- FAQ --\u003e\n\n## :grey_question: FAQ\n\n- What is Russ?\n\n  - 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.\n\n- How do I use Russ?\n\n  - 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.\n\n- Does Russ work with all types of text?\n\n  - Russ works with all types of text, including lengthy articles, complex documents, and even scanned images.\n\n- Is Russ accurate?\n\n  - Russ uses advanced AI algorithms via \u003cu\u003eOpenAI's API\u003c/u\u003e to provide accurate answers to your questions. However, it is still important to verify the information obtained through Russ against other sources.\n\n- How does Russ extract text from an image?\n\n  - Russ uses optical character recognition (OCR) technology from \u003cu\u003e Tesseract.js \u003c/u\u003e to extract text from an image. This allows you to analyze and understand text that is not available in a digital format.\n\n- Can I ask multiple questions about the same text?\n\n  - Yes, you can ask multiple questions about the same text and get instant answers to each one.\n\n\u003cbr\u003e\n\u003c!-- License --\u003e\n\n## :warning: \u0026nbsp; License\n\nDistributed under the \u003cb\u003eAGPL-3.0\u003c/b\u003e License, See LICENSE.txt for more information.\n\n\u003cbr\u003e\n\n\u003c!-- Contact --\u003e\n\n## :handshake: \u0026nbsp; Contact\n\n\u003e \u003cb\u003eEmail: \u003c/b\u003e l.d.b.dasanayaka@gmail.com\n\n### :copyright: \u0026nbsp; Designed and Developed by Lithika Damnod\n\n\u003ca href=\"https://www.linkedin.com/in/lithika-damnod/\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge\u0026logo=linkedin\u0026logoColor=white\"\u003e\n\u003c/a\u003e\n\u003ca href=\"https://twitter.com/lithika_damnod\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge\u0026logo=twitter\u0026logoColor=white\"\u003e\n\u003c/a\u003e\u003cbr\u003e\n\u003ca href=\"https://www.buymeacoffee.com/lithikadamnod\"\u003e\u003cimg src=\"https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge\u0026logo=buy-me-a-coffee\u0026logoColor=black\"\u003e\u003c/a\u003e\u003cbr\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flithika-damnod%2Fruss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flithika-damnod%2Fruss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flithika-damnod%2Fruss/lists"}