{"id":21651792,"url":"https://github.com/dev-vivekkumarverma/spellchecker","last_synced_at":"2026-02-21T21:35:13.981Z","repository":{"id":251859576,"uuid":"838654982","full_name":"dev-vivekkumarverma/SpellChecker","owner":"dev-vivekkumarverma","description":"this uses very efficient data-structure for storing and fast searching of the words (Trie datastructure) and uses persistent storage","archived":false,"fork":false,"pushed_at":"2025-02-25T07:04:57.000Z","size":2001,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-11T20:42:03.295Z","etag":null,"topics":["autocomplete","autocomplete-search","autocomplete-suggestions","autosuggest","data-structures","fastapi","spellcheck","trie","trie-tree"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dev-vivekkumarverma.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-08-06T05:05:10.000Z","updated_at":"2025-02-25T07:05:00.000Z","dependencies_parsed_at":"2025-04-11T20:34:54.735Z","dependency_job_id":"715f00db-640b-4570-8c5d-5943b30e9345","html_url":"https://github.com/dev-vivekkumarverma/SpellChecker","commit_stats":null,"previous_names":["dev-vivekkumarverma/spellchecker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dev-vivekkumarverma/SpellChecker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2FSpellChecker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2FSpellChecker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2FSpellChecker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2FSpellChecker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dev-vivekkumarverma","download_url":"https://codeload.github.com/dev-vivekkumarverma/SpellChecker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-vivekkumarverma%2FSpellChecker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29694210,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-21T18:18:25.093Z","status":"ssl_error","status_checked_at":"2026-02-21T18:18:22.435Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["autocomplete","autocomplete-search","autocomplete-suggestions","autosuggest","data-structures","fastapi","spellcheck","trie","trie-tree"],"created_at":"2024-11-25T07:49:34.356Z","updated_at":"2026-02-21T21:35:13.966Z","avatar_url":"https://github.com/dev-vivekkumarverma.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# SpellChecker\n\nSpellChecker is a FastAPI-based application designed to efficiently manage and check the spelling of words. It utilizes a Trie data structure for quick word lookup and a JSON file to store words permanently.\n\n## Features\n\n- **Word Suggestions**: Get word suggestions based on a provided prefix.\n- **Word Validation**: Check if a word exists in the dictionary.\n- **Insert Word**: Add new words to the dictionary.\n\n## Scope\n\nThis project can be integrated into applications requiring auto-fill and auto-suggestions functionalities, enhancing user experience by providing real-time word suggestions and validations.\n\n## Installation\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/dev-vivekkumarverma/SpellChecker.git\n   cd spellchecker\n   ```\n\n2. **Install the required packages:**\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n3. **Run the FastAPI server:**\n\n   ```bash\n   uvicorn main:app --reload\n   ```\n\n## API Endpoints\n\n### Suggest Words\n\n- **URL**: `/suggest/{word_prefix}`\n- **Method**: `GET`\n- **Description**: Get word suggestions based on the provided prefix.\n- **Example**:\n  ```bash\n  curl --location 'localhost:8000/suggest/hel'\n  ```\n  - **Response**:\n    ```json\n    {\n      \"given_pref\": \"hel\",\n      \"suggestions_count\": 545,\n      \"suggestions\": [\"hel\", \"hela\", \"helain\", \"helaina\", \"helaine\", ...]\n    }\n    ```\n\n### Check Word Presence\n\n- **URL**: `/{word}`\n- **Method**: `GET`\n- **Description**: Check if a word exists in the dictionary.\n- **Example**:\n  ```bash\n  curl --location 'localhost:8000/Methionylthreonylthreonylglutaminylarginyltyrosylglutamylserine'\n  ```\n  - **Response**:\n    ```json\n    {\n      \"searched_word\": \"methionylthreonylthreonylglutaminylarginyltyrosylglutamylserine\",\n      \"is_found\": true\n    }\n    ```\n\n### Insert New Word\n\n- **URL**: `/insert/{word}`\n- **Method**: `POST`\n- **Description**: Add a new word to the dictionary.\n- **Example**:\n  ```bash\n  curl --location --request POST 'localhost:8000/insert/pneumonoultramicroscopicsilicovolcanoconiosis'\n  ```\n  - **Response**:\n    ```json\n    {\n      \"word\": \"pneumonoultramicroscopicsilicovolcanoconiosis\",\n      \"is_inserted\": true\n    }\n    ```\n\n## Data Structure\n\nThe application uses a `Trie` data structure for efficient word storage and retrieval, ensuring fast operations even with a large dataset.\n\n## Persistent Storage\n\nWords are stored in a JSON file, allowing the dictionary to persist between restarts of the application.\n\n## API Documentation\n\nFor detailed API documentation, visit [Postman API Documentation](https://documenter.getpostman.com/view/26583578/2sA3rxqtBy).\n\n## Contributing\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Commit your changes (`git commit -am 'Add new feature'`).\n4. Push to the branch (`git push origin feature-branch`).\n5. Create a new Pull Request.\n\n## License\n\nThis project is licensed and reserved by the author (dev-vivekkumarverma) Vivek Kumar Verma.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-vivekkumarverma%2Fspellchecker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdev-vivekkumarverma%2Fspellchecker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-vivekkumarverma%2Fspellchecker/lists"}