kata-scrabbled

README

Scrabbled

⚠️ WARNING: Not production ready code, instead a Code Kata intended to hone my programming skills through practice and repetition.

A solving program that suggests words using your current letters and the layout of the board.

• Getting Started
• Verification
• Design
• Security
• Attribution
• References
• License

Getting Started

Prepare

Begin by installing Go if you have not done so already.

You can test your install by calling the following command:

go version

Your version must be greater than or equal to the version defined in ./go.mod file.

Install, Verify, and Build

Install, verify, and build ./scrabbled binary.

nvm use && make

Run

./scrabbled

Visit http://localhost:8080

Help

Not Yet Implemented

Verification

Linting

• Prettier
• gofmt

make lint

These rules can then be automatically applied:

make format

Unit Testing

• go test

make test

Design

Repository Structure

Directory	Purpose
./.github/workflows	GitHub Actions workflow definitions.
./cmd/scrabbled	CLI implementation, including main.go.
./internal/domain	Application domain, isolated from external resources.
./internal/gateway	Encapsulated access to resources external from the applicaiton domain.
./support	Static resources used to support this application.
./web	Web user interface implementation.

Security

See the Security Policy.

Attribution

Words List

./support/words.txt accessed from github.com/dwyl/english-words, accessed under public domain.

References

None currently.

License

The MIT License is used by this project.