/summaryApp

summaryApp is a Django web application that summarizes articles using OpenAI's GPT-3 API and News API, with a ReactJS frontend.

Primary LanguagePython

summaryApp

summaryApp is a Django web application that uses OpenAI's GPT-3 API to summarize articles obtained from the News API and scraped with BeautifulSoup 4. For frontend ReactJS is used.

Prerequisites

To run summaryApp, you will need to have Python 3.7 or later installed on your system. You will also need a OpenAI API key and News API key

Installation

  1. Clone the repository - git clone https://github.com/luisKisters/summaryApp
  2. Run setup.py - python3 setup.py
  3. Put your OpenAI API key key into summarize/api_key.txt and your News API key into article/api_key.txt

Starting

  1. Start Django Server - python3 manage.py runserver
  2. Go in your browser to localhost:8000/ (don't go to 127.0.0.1:8000/ this isn't working)

Design

Click here to open Figma design

Flowchart

Click here to open Lucidspark flowchart

ToDo

  • Make selecting article topic and time period work
    • Stop summarizing articles from localhost:8000/ because this returns article with default parameters and not selected parameters
  • Explain how to use API in README.md
  • Start using GitHub Issues instead of ToDo list for issues/nugs/errors
  • Add tests
  • Add workflows
  • Add automated build
  • (Summarize.jsx) Add that if the the API request to http://localhost:8000/api/summary/EN/100/ doesn't return statusText: 'OK' the error gets displayed in
  • Make visiting Django webserver over 127.0.0.1:8000/ possible
  • Use priority system for tasks with colors
  • Maybe start using a software for tasks
  • Add that if article_api.py returns no articles, display an error
  • Automatically sort solved ToDos/Tasks to bottom of Todo_list.md
  • Add README.md
  • Change summary API response format to so that it only returns the summary, not the article

ToDo list file