Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 3.05 KB

README.md

File metadata and controls

69 lines (50 loc) · 3.05 KB

CiteAssist

CiteAssist

CiteAssist generates preprints, suggests related papers, and adds BibTeX annotation to the PDF

Build Status License GitHub forks GitHub stars

Report Bug · Request Feature

CiteAssist is a powerful tool that allows users to generate preprints with suggested related papers and add a BibTeX annotation to the PDF.

Prerequisites

To use CiteAssist, you must have Node version 16.13.0 or higher installed on your machine.

Getting Started

To get started, simply clone this repository and follow the instructions in the frontend and backend READMEs:

Features

CiteAssist offers the following features:

  • Generate preprints with related papers: The tool utilizes powerful algorithms to suggest related papers to include in your preprint, helping you to create more comprehensive and impactful research.
  • Add a BibTeX annotation to the PDF: The tool also generates a BibTeX annotation, which can be used to easily cite your preprint in other works.

Contributing

We welcome contributions to CiteAssist! If you encounter a bug, have a feature request, or would like to contribute code, please open an issue or pull request on this repository.

License

This project is licensed under the MIT License. Please refer to the LICENSE file for more information.

Citation

If you use this software, please cite it using the following BibTeX entry:

@software{kaesberg2024,
  author = {Kaesberg, Lars Benedikt and Ruas, Terry and Wahle, Jan Philip and Gipp, Bela},
  license = {MIT},
  month = jul,
  title = {{CiteAssist: A System for Automated Preprint Citation and BibTeX Generation}},
  version = {1.0},
  year = {2024}
}

TODO

  • use compromise for nlp keyword detection
  • website for each preprint in backend (pdf, annotation, related papers)
  • alpaca lora for metadata extraction