Git Product home page Git Product logo

thesaurust's Introduction

Table of Contents

thesaurust

A simple dictionary application built within the terminal, written in Rust. Demo

How it works

The data is fetched from the API provided by https://dictionaryapi.dev/. Since words can contain more than one meanings, the user can toggle between different meanings based on the parts of speech the word has.

Installation

You need to install Rust before you can proceed.
Clone this repository:

git clone https://github.com/QuietPigeon2001/thesaurust

Navigate to the repository and run the following commands:

cargo install --path .
thesaurust

Installation (with spellchecking)

Demo

Prerequisites

You need to have an API key from SerpApi before you can enable this feature. It is free of charge with a limited number of usage.
Go to api_key.rs and enter your API key:

pub const API_KEY: &str = "YOUR_API_KEY";

Then, you can proceed to installation.

Enabling spellchecking

To enable spellchecking in the app, press : after launching the app. At the footer, you will see something like

Spelling suggestion: false

Toggle to Spelling suggestion to true with l or h, then press q to exit.

Usage

  • /: Insert the word you would like to look up.
  • Enter: Search.
  • j, k: Select the part of speech and press Enter.
  • l, h: Toggle between multiple definitions.
  • q: Exit the app.

Roadmap

  • Show an example with the definition (if available)
  • Toggle between parts of speech
  • Toggle between definitions with the same part of speech
  • Use a spellchecking API to suggest correct spelling for words
  • Show synonyms

thesaurust's People

Contributors

quietpigeon avatar

Stargazers

Derek Verbeeck avatar TornaxO7 avatar Gil Melfe avatar Lennart Kiil avatar Moonbench avatar Ribbon avatar Yura avatar Aaron Tsui avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.