README.md

Article Summarisation backend based on FastAPI

Frontend

• Mobile app: https://github.com/rafapi/summariser_client

Details

• CI/CD via Github Actions
• Automatic deployment to Heroku
• Dev dependencies
  • FastAPI: https://fastapi.tiangolo.com
  • Tortoise-ORM: https://tortoise-orm.readthedocs.io/
  • Newspaper3k: https://newspaper.readthedocs.io/
  • Docker: https://docs.docker.com/
• Testing:
  • pytest: https://docs.pytest.org/en/stable
  • pytest-cov: https://github.com/pytest-dev/pytest-cov
  • Codecov: https://docs.codecov.io
• Linting and Formatting:
  • black: https://github.com/psf/black
  • flake8: https://flake8.pycqa.org/en/latest
  • isort: https://pycqa.github.io/isort

ToDo

• Authentication
• Extra information fields based on third-party content
• Add images if available from the original source