Essentially

Only read the essentials

Table of Contents

• About Essentially
• Getting Started
• Screenshots
• Roadmap
• Contributing

About Essentially

A tool to spend your time reading what's actually important. Essentially is a Chrome extension that analyzes and summarizes articles on the web. Additionally, you can use Lens to delve deeper into what you want to know more

Getting Started

We plan to publish Esentially on the Chrome Webstore by April 2023; but, fret not, you can download and setup Esentially on your laptop or desktop and use it. there are 3 main steps to get Essentially up and running and should take no more than a few minutes

Setup

• you need to first setup the extension locally on Chrome
  • Refer to the readme located in the frontend folder on how to setup and run the extension
• To connect the extension to the server you should run the extension API and ML servers simultaneously
  • Refer to the readme located in the backend folder on how to run the server
  • Refer to the readme located in the summary_be folder on how to run the server

Screenshots

• Initial Popup

• Loading Summary

• Summary Results

Roadmap

we anticipate to have 3 major phases before Essentially is essentially done (pardon the pun). so far Phase 1 is completed and Phase 2 has started.

Phase 1:

• Extension setup and design
• basic text extraction
• basic text summarization and keyword finder
• text hover and lookup

Phase 2: (Main gist)

• Summary 2.0
• Lens 2.0
• UX/UI enhancements

Phase 3

TBD

Contributing

Everyone is welcome to contribute to the project. You can contribute via two ways:

• you can give us feedback by using Essentially and submit feature requests or bug reports in the Issues section of this repository
• Alternatively, if you see an open issue you'd like to work on (we suggest ones with good first issue label if it's your first time contributing), comment on the issue to be assigned and fork the repository. Once you've resolved the issue, make a PR and one of the team members can review.

side note: Any Launchpad member that wants to be a bit more hands-on on this project, and be involved in the decision-making as well, please message one of the team members.