Spark Sum — Summarize Text in a Spark

SparkSum is a text summarization application.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

SparkSum is a text summarizer powered by the OpenAI API's chat completion feature. The user will enter a text they want summarized, as well as the desired word count of the outputted summarized text. This application has not been deployed.

Key Features

• Builds concise and high quality summaries
• Creates summarizes based on the user's specified word count

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

Install Node.JS at https://nodejs.org/en/download/current

• Install npm

  npm install npm@latest -g

Installation

1. Get a free OpenAPI Key by following this video: https://youtu.be/nafDyRsVnXU?si=iDQBrmgxrt5_lF9x
2. Clone the repo

   git clone https://github.com/ErikTsai/spark-sum

3. Install NPM packages

   npm install http-server -g

4. Enter your API key in env.js

   OPENAI_API_KEY: 'ENTER YOUR KEY';

5. Navigate to the path of the spark-sum folder and run in your terminal

   http-server

6. The Application should be open at localhost:8080
7. To close the server, CTRL+C into the same terminal you opened the server

(back to top)

Roadmap

• Deploy Application
• Improve Current Styling
• Add Mobile Styling

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. 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". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

• LinkedIn: Erik Tsai
• Project Link: Spark Sum

(back to top)