{"id":13598982,"url":"https://github.com/quietpigeon/thesaurust","last_synced_at":"2025-04-10T10:30:49.720Z","repository":{"id":208270801,"uuid":"703908203","full_name":"quietpigeon/thesaurust","owner":"quietpigeon","description":"A terminal-based dictionary app.","archived":false,"fork":false,"pushed_at":"2024-03-27T01:48:48.000Z","size":1335,"stargazers_count":16,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-03T17:04:15.144Z","etag":null,"topics":["cli","ratatui","rust","terminal","terminal-based","tui"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quietpigeon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-10-12T06:48:37.000Z","updated_at":"2025-03-29T17:35:59.000Z","dependencies_parsed_at":"2024-01-16T23:26:23.693Z","dependency_job_id":"ba83cf35-54ec-444c-989b-fcbf5f248cc0","html_url":"https://github.com/quietpigeon/thesaurust","commit_stats":null,"previous_names":["quietpigeon2001/thesaurust","quietpigeon/thesaurust"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quietpigeon%2Fthesaurust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quietpigeon%2Fthesaurust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quietpigeon%2Fthesaurust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quietpigeon%2Fthesaurust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quietpigeon","download_url":"https://codeload.github.com/quietpigeon/thesaurust/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248142954,"owners_count":21054671,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","ratatui","rust","terminal","terminal-based","tui"],"created_at":"2024-08-01T17:00:58.707Z","updated_at":"2025-04-10T10:30:48.945Z","avatar_url":"https://github.com/quietpigeon.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdetails\u003e\n\u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n- [thesaurust](#thesaurust)\n  - [Installation](#installation)\n  - [Installation (with spellchecking)](#installation-with-spellchecking)\n    - [Prerequisites](#prerequisites)\n    - [Enabling spellchecking](#enabling-spellchecking)\n  - [Usage](#usage)\n  - [Roadmap](#roadmap)\n\u003c/details\u003e\n\n# thesaurust\nA simple dictionary application built within the terminal, written in Rust. \n![Demo](docs/demo.gif)\n## How it works\nThe 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.\n## Installation\nYou need to install [Rust](https://www.rust-lang.org/tools/install) before you can proceed.\n\u003cbr\u003e\nClone this repository:\n```zsh\ngit clone https://github.com/QuietPigeon2001/thesaurust\n```\nNavigate to the repository and run the following commands:\n```zsh\ncargo install --path .\nthesaurust\n```\n## Installation (with spellchecking)\n![Demo](docs/spellcheck_demo.gif)\n### Prerequisites\nYou need to have an API key from [SerpApi](https://serpapi.com/) before you can enable this feature. It is free of charge with a limited number of usage.\n\u003cbr\u003e\nGo to [api_key.rs](src/api_key.rs) and enter your API key:\n```zsh\npub const API_KEY: \u0026str = \"YOUR_API_KEY\";\n```\nThen, you can proceed to [installation](#installation).\n### Enabling spellchecking\nTo enable spellchecking in the app, press \u003ckbd\u003e:\u003c/kbd\u003e after launching the app. At the footer, you will see something like\n```zsh\nSpelling suggestion: false\n```\nToggle to `Spelling suggestion` to `true` with \u003ckbd\u003el\u003c/kbd\u003e or \u003ckbd\u003eh\u003c/kbd\u003e, then press \u003ckbd\u003eq\u003c/kbd\u003e to exit.\n## Usage\n* \u003ckbd\u003e/\u003c/kbd\u003e: Insert the word you would like to look up.\n* \u003ckbd\u003eEnter\u003c/kbd\u003e: Search.\n* \u003ckbd\u003ej\u003c/kbd\u003e, \u003ckbd\u003ek\u003c/kbd\u003e: Select the part of speech and press \u003ckbd\u003eEnter\u003c/kbd\u003e.\n* \u003ckbd\u003el\u003c/kbd\u003e, \u003ckbd\u003eh\u003c/kbd\u003e: Toggle between multiple definitions.\n* \u003ckbd\u003eq\u003c/kbd\u003e: Exit the app.\n## Roadmap\n- [x] Show an example with the definition (if available)\n- [x] Toggle between parts of speech \n- [x] Toggle between definitions with the same part of speech\n- [x] Use a spellchecking API to suggest correct spelling for words\n- [x] Show synonyms\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquietpigeon%2Fthesaurust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquietpigeon%2Fthesaurust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquietpigeon%2Fthesaurust/lists"}