Skip to content

A desktop text editor which gives you citations as you write on the go

License

Notifications You must be signed in to change notification settings

SudodevsHQ/citewrite

Repository files navigation


CiteWrite
Citations on the go.

A minimal Text Editor desktop app built on top of Electron.

CiteWrite

---

CiteWrite

--- ---

NLP (Natural Language Processing) powered Minimal Text Editor App which fetches citations and facts from the internet for the user's reference to save time taken by switching tabs and manually searching for them.

Key FeaturesHow To UseCreditsLicense

Key Features

  • LiveCitations - Get information from internet resources for the topic you are writing automatically.
  • Resource Pinning - You can save the resources that you would like to use more for the current session.
  • Syntax highlighting
  • Toolbar for basic formatting
  • Full screen mode
    • Write distraction free.
  • Cross platform
    • Windows, macOS and Linux ready.

How To Use

To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/sudodevs-inc/citewrite.git

# Go into the repository
$ cd citewrite

# Install dependencies
$ npm install

# Run the app
$ npm start

To deploy the server instance as to utilize NLP and the developed web search modules:

# Clone the server repository
$ git clone https://github.com/sudodevs-inc/citewriteBackend.git

# Go into the repository
$ cd citewriteBackend

# Install virtual environment for Python version 3.6.*
$ python3.6 -m pip install virtualenv --user && python3.6 -m virtualenv env

# Activate the environment
$ . env/bin/activate

# Install requirements
$ pip install -r requirements.txt

# Install the spacy 'en' pack
$ spacy download en

# Run the server
$ python main.py

Credits

This software uses the following open source packages:

Areas of Improvement

  • Less computing power causes NLP to takes 4-5 seconds for fetching keywords that are then used to fetch the resources off Wikipedia thus causing decent load times as of now which can be improved with good hardware.
  • Due to lack of free data APIs, the searching is restricted to Wikipedia only as of now.
  • UI can always be improved.

License

MIT


SudoDevs  ·  GitHub @sudodevs-inc  · 

About

A desktop text editor which gives you citations as you write on the go

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published