https://github.com/mlh-fellowship/simplify
Simplify is a Chrome Extension that summarizes any article you're reading in just one click!
https://github.com/mlh-fellowship/simplify
chrome-extension newspaper3k
Last synced: about 2 months ago
JSON representation
Simplify is a Chrome Extension that summarizes any article you're reading in just one click!
- Host: GitHub
- URL: https://github.com/mlh-fellowship/simplify
- Owner: MLH-Fellowship
- License: mit
- Created: 2020-11-03T23:20:38.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-11-11T23:05:05.000Z (almost 5 years ago)
- Last Synced: 2024-12-16T19:13:32.069Z (10 months ago)
- Topics: chrome-extension, newspaper3k
- Language: Jupyter Notebook
- Homepage:
- Size: 3.02 MB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Simplify :pen:
Simplify is a Chrome Extension that summarizes any article you're reading in just one click!
It calls on an API that was made and deployed on Herkou to get the summary of the article.
## Motivation
> The advent of the 21st century has ushered in the information era. Our race has evolved to process mountains of information every day. However, the attention spans of future generations are steadily decreasing. To combat this, we have created Simplify, an innovative tool that allows humans to process large amounts of information at lightning speeds.
## Screenshots
## Technologies Used
- [Newspaper3k](https://newspaper.readthedocs.io/en/latest/)
- [Flask](https://flask.palletsprojects.com/en/1.1.x/)
- [Herkou](https://www.heroku.com//)
- Vanilla Javascript, HTML, and CSS
## Installation
The Developers couldn't get this on the Chrome Extension Store, so here are the steps to add it to yourself!
1. clone this repo. on your local machine (git clone https://github.com/MLH-Fellowship/Simplify.git)
2. type `chrome://extensions` into Google Chrome and on the top right, turn on developer mode
3. on the top left, press `Load unpacked`
4. in the directory where you saved this repo. and select the `src` folder
5. you can now use our extension!
## How to Use?
1. Open an article on your browser
2. Click the Simplify Extension
3. Read the summary
## API Reference
### Usage
URL: https://summary-api-zzranger.herokuapp.com/
##### Endpoint
`GET` https://summary-api-zzranger.herokuapp.com/query?article=`{articleUrl}`
> Gets the summary for the article located at `articleUrl`
##### Parameters
`{articleUrl}`
> The URL of the article you want the summary of
##### Sample Request
```
curl -I -X GET "https://summary-api-zzranger.herokuapp.com/query?article=https://stories.mlh.io/the-mlh-fellowship-is-back-this-fall-eedc9ffa7874"
```
> Getting the summary from https://stories.mlh.io/the-mlh-fellowship-is-back-this-fall-eedc9ffa7874
##### Sample Response
```json
{
"summary": "Our first MLH Fellowship, launched back in May, had nearly 20,000 amazing applicants from around the world.\nWe are now publishing our forward-looking schedule with a Fall 2020, Spring 2021, and Summer 2021 Fellowship already in the works.\nWe look forward to seeing all of the amazing applicants for our Fall 2020 MLH Fellowship batch and as always, we can’t wait to see what you build."
}
```
##### Response Definitions
`summary`
> Summary of the article located at `articleUrl`
### Installation
Follow these steps if you want to run the API locally
1. Open the root directory (should be the Simplify folder)
2. Navigate to the heroku folder (cd heroku)
3. Install the necessary libraries (pip install -r requirements.txt)
4. Run the flask server (python wsgi.py)
The API will now run on localhost:9874. Follow the API reference above to get article summaries (replace domain name w/ localhost).
Example
``` http://localhost:9874/query?article=https://www.cnn.com/politics/live-news/election-results-and-news-11-09-20/index.html ```
## Other
Devpost Submission: https://devpost.com/software/simplify-cvn8mg
Text_Summarizer_Models.ipynb: This Jupyter notebook contains the BART text-summarization model, which the team is currently investigating. We plan on implementing either this particular model or something similar to handle text-summarization over newspaper3k.
## Made with ❤️ by Pod 1.1.6 - the Git Geese:
| Cirill Dalangin | Clara Chick | Caleb Lim |
| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |
| [
](https://florenz.tech/)
[🌍](https://florenz.tech/) [💻](https://github.com/cdalangin) [🤝](https://www.linkedin.com/in/cfdalangin/) | [
](https://clarachick.me/)
[🌍](https://clarachick.me/) [💻](https://github.com/KohinaTheCat) [🤝](https://www.linkedin.com/in/clarachick/) | [
](https://github.com/ZzRanger)
[💻](https://github.com/ZzRanger) [🤝](https://www.linkedin.com/in/caleb-lim-b243a61ba/) |