toomanywords

This project is an Artificial Intelligence-powered automatic text summary webapp.

Installation

0. Ensure node and yarn are installed on your machine.

   • node installation for Windows/Mac
   • node installation for Ubuntu
   • yarn installation

1. Clone this repo with:

git clone https://github.com/Ramanathan0908/Orbital.git

2. Install yarn packages with:

yarn install

3. Install required python packages

python3 -m pip install -r requirements.txt

Usage

1. In a terminal window, Navigate to the repo folder and start the summarizer with yarn summarizer:

$ yarn summarizer

2. In another terminal window, navigate to the repo folder and start the App with:

$ yarn start

4. Enter login details. (The sign-in feature is currently incomplete so use the following username and password):

Username: [email protected]
Password: password

5. Choose the word limit for the summary.

6. Choose the type of text to be summarised from the drop-down list.

7. Type your input text into the text box and hit the SUMMARIZE button.

8. Hit the CLEAR button to reset or hit the CREATE button to save.

9. When saving, enter the title of that summary.

10. Click the icon in the top left and go to Saved Summaries in the sidebar to view the previous saved summaries.

Credits

This project was bootstrapped with Create React App.

The summariser utilises pretrained models from Hugging Face Transformers