Data

Tools

Indexes

Applications

Experiments

Open Source Science

citeassist

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

https://github.com/gipplab/citeassist

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.2%) to scientific vocabulary

Keywords

bibtex enhancement preprint
Last synced: 6 months ago · JSON representation ·

Repository

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

Basic Info
Statistics
  • Stars: 5
  • Watchers: 2
  • Forks: 0
  • Open Issues: 15
  • Releases: 3
Topics
bibtex enhancement preprint
Created over 3 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md


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

Try CiteAssist!

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:

bibtex @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
  • [x] website for each preprint in backend (pdf, annotation, related papers)
  • [ ] alpaca lora for metadata extraction

Owner

  • Name: Scientific Information Analytics Group, Prof. Gipp
  • Login: gipplab
  • Kind: organization
  • Location: Germany

Scientific Information Analytics Group of Prof. Bela Gipp at the University of Göttingen

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: >-
  CiteAssist: A System for Automated Preprint Citation and
  BibTeX Generation
message: >-
  If you use this software, please cite it using the
  following metadata.
type: software
authors:
  - family-names: Kaesberg
    given-names: Lars Benedikt
  - family-names: Ruas
    given-names: Terry
  - family-names: Wahle
    given-names: Jan Philip
  - family-names: Gipp
    given-names: Bela
identifiers:
  - type: url
    value: 'https://citeassist.uni-goettingen.de'
    description: Tool
  - type: url
    value: 'https://arxiv.org/abs/2407.03192'
    description: arXiv
abstract: >-
  We present CiteAssist, a system to automate the generation
  of BibTeX entries for preprints, streamlining the process
  of bibliographic annotation. Our system extracts metadata,
  such as author names, titles, publication dates, and
  keywords, to create standardized annotations within the
  document. CiteAssist automatically attaches the BibTeX
  citation to the end of a PDF and links it on the first
  page of the document so other researchers gain immediate
  access to the correct citation of the article. This method
  promotes platform flexibility by ensuring that annotations
  remain accessible regardless of the repository used to
  publish or access the preprint. The annotations remain
  available even if the preprint is viewed externally to
  CiteAssist. Additionally, the system adds relevant related
  papers based on extracted keywords to the preprint,
  providing researchers with additional publications besides
  those in related work for further reading. Researchers can
  enhance their preprints organization and reference
  management workflows through a free and publicly available
  web interface. 
keywords:
  - citation
  - BibTeX
  - preprints
  - bibliographic annotation
  - metadata extraction
license: MIT
commit: e25aeff
version: '1.0'
date-released: '2024-07-02'

GitHub Events

Total
  • Issues event: 1
  • Issue comment event: 1
  • Push event: 15
Last Year
  • Issues event: 1
  • Issue comment event: 1
  • Push event: 15

Dependencies

.github/workflows/main.yml actions
  • actions/checkout v2 composite
  • docker/build-push-action v2 composite
  • docker/login-action v1 composite
backend/Dockerfile docker
  • node 16-alpine build
docker-compose.dev.yml docker
  • lfoppiano/grobid 0.8.0
  • postgres latest
docker-compose.yml docker
  • lfoppiano/grobid 0.8.0
  • postgres latest
frontend/Dockerfile docker
  • nginx alpine build
  • node 16-alpine build
backend/package-lock.json npm
  • 174 dependencies
backend/package.json npm
  • nodemon ^3.0.2 development
  • axios ^1.6.8
  • body-parser ^1.20.2
  • cookie-parser ~1.4.4
  • cors ^2.8.5
  • debug ~2.6.9
  • express ~4.18.2
  • form-data ^4.0.0
  • http-errors ~1.6.3
  • jade ^1.9.2
  • morgan ~1.10.0
  • multer ^1.4.5-lts.1
  • pg ^8.8.0
  • wink-eng-lite-web-model ^1.5.2
  • wink-nlp ^1.14.3
  • xml2js ^0.6.2
frontend/package-lock.json npm
  • 1349 dependencies
frontend/package.json npm
  • @types/unidecode ^0.1.3 development
  • @types/uuid ^9.0.7 development
  • eslint ^8.56.0 development
  • eslint-config-react-app ^7.0.1 development
  • @emotion/react ^11.10.5
  • @emotion/styled ^11.10.5
  • @mui/icons-material ^5.11.0
  • @mui/lab ^5.0.0-alpha.114
  • @mui/material ^5.11.2
  • @mui/x-date-pickers ^5.0.12
  • @retorquere/bibtex-parser ^7.0.8
  • @testing-library/jest-dom ^5.16.5
  • @testing-library/react ^14.1.2
  • @testing-library/user-event ^14.5.2
  • @types/jest ^29.5.11
  • @types/node ^20.10.8
  • @types/react ^18.2.47
  • @types/react-dom ^18.2.18
  • acorn-dynamic-import ^4.0.0
  • dayjs ^1.11.10
  • jspdf ^2.5.1
  • pdf-lib ^1.17.1
  • react ^18.2.0
  • react-dom ^18.2.0
  • react-drag-drop-files ^2.3.10
  • react-router-dom ^6.21.1
  • react-scripts ^5.0.1
  • typescript ^5.3.3
  • unidecode ^1.0.1
  • uuid ^9.0.1
  • web-vitals ^2.1.4