https://github.com/jimlynchcodes/n-letter-wordle-cli
A wordle clone, played in the command line, with words of any length.
https://github.com/jimlynchcodes/n-letter-wordle-cli
Last synced: 5 months ago
JSON representation
A wordle clone, played in the command line, with words of any length.
- Host: GitHub
- URL: https://github.com/jimlynchcodes/n-letter-wordle-cli
- Owner: JimLynchCodes
- License: mit
- Created: 2023-06-12T16:12:51.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-28T18:24:06.000Z (over 1 year ago)
- Last Synced: 2025-10-30T14:37:35.487Z (8 months ago)
- Language: Rust
- Homepage:
- Size: 20.2 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# N Letter Wordle Game
A wordle clone, played in the command line, with words of any length. Also, this version gives you the definitions of the word when the game is over. 🥇
## Disclaimer
_We are not affiliated at all with Wordle or New York Times. This is simply a toy project for [Jim](github.com/JimLynchCodes) to practice building cli tools and coding in Rust..._
## Try The Live, Deployed CLI Tool!
Two different ways to install: via npm or via cargo.
### Installation Method 1) NPM
Install `n-letter-wordle` as a global npm dependency:
```sh
npm i -g n-letter-wordle
```
### Installation Method 2) Cargo
Install `n-letter-wordle` as a global npm dependency:
```sh
cargo install n-letter-wordle
```
## Local Dev
Clone this project, then run it with cargo:
```
cargo run
```
Run unit & integration tests:
```
cargo test
```
Run format & linting checks:
```
cargo fmt
cargo clippy
```
## Production build
Build with the release flag:
```
cargo build --release
```
## Deploy
First, login to cargo and npm
```
cargo login
npm adduser
```
Then I deployed with [rust-to-npm](https://github.com/a11ywatch/rust-to-npm):
```
rust-to-npm-cli deploy -b
```