Simplifier

A reading tool designed to simplify / organize / summarize papers or reports

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contact

About The Project

Built With

ReactJS and Express using the OpenAI API

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps. Make sure you have the prerequisites listed below.

Prerequisites

• Node Package Manager (npm) https://nodejs.org/en/download. If required, update npm below:

  npm install npm@latest -g

Installation

1. Get an API Key at https://platform.openai.com/

2. Clone the repo

   git clone https://github.com/Quackens/Simplifier.git

3. Enter your API in config.js

   const constants = {
    const API_KEY = 'ENTER YOUR API'
   }

4. Go into the backend directory

   cd Simplify/backend

5. Install NPM packages for the Express server

   npm install

6. Run the NPM development server

   npm run dev

7. Open another terminal window. Go into the frontend directory and install the npm dependencies. Then run the reaect app

   cd ../frontend
   npm install
   npm start

8. Use the web app at http://localhost:3000/. Enjoy!

(back to top)

Usage

Add and Change Text

Enter your text in the input field, and add it to the site. From there, you have a few options to use with this text:

• Simplify: Converts the text to make it less technical, changing it into layman terms and eliminating jargon
• Bullet Points: Converts the text into a few bullet points, for concise reading
• Summarize: Summarizes the text into a more succint paragraph
• Add to Linked Texts: Adds this text to the linked selection, explained below
• Delete: delete this text from the site

Linking Text

Once you have added your choices of texts to the "Linked Texts" section, you may do the following:

• Generate Similarity Report: Generates a paragraph summarizing the trends and similarities that the two texts have in common
• Search Query: type in a search query, (e.g Asking "Trend for Tesla Stock" for the example SP500 reports) and getting an answer based only on the text information it is given

Results

The results of each request is generated here. In this example, I asked "Trend for Tesla Stock" in the search query, after linking articles 2 and 3:

(back to top)

Contact

Jimmy Zhou - jameszho@andrew.cmu.edu

Project Link: https://github.com/Quackens/Simplifier

(back to top)