https://github.com/mughieams/guess-word
🎲 A simple quiz game using CLI
https://github.com/mughieams/guess-word
command-line quiz-game ruby
Last synced: over 1 year ago
JSON representation
🎲 A simple quiz game using CLI
- Host: GitHub
- URL: https://github.com/mughieams/guess-word
- Owner: mughieams
- Created: 2020-03-13T15:52:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-08T11:57:54.000Z (over 3 years ago)
- Last Synced: 2023-03-06T15:03:01.568Z (over 3 years ago)
- Topics: command-line, quiz-game, ruby
- Language: Ruby
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Guess Word
[](https://circleci.com/gh/mughieams/guess-word/tree/master)
A simple quiz game with command-line based (CLI)
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
1. Ruby `2.6.0`. You can follow this [instruction](https://www.ruby-lang.org/en/documentation/installation/) for the installation procedure.
2. Bundler `2.1.4`. You can execute this command below:
```console
$ sudo gem install bundler
```
### How to use
These commands below will help you to use this project properly.
For the first, you need to clone this repository then run:
```
$ bundle install --path vendor/bundle
```
### When working
#### Running the tests
Open this project directory on terminal and execute this command below:
```console
$ bundle exec rspec spec
```
#### Verifying code style
Open this project directory on terminal and execute this command below:
```console
$ bundle exec rubocop
```
You can reformat the code by executing:
```console
$ bundle exec rubocop -a
```
### When running this project
Open this project directory on terminal and execute this command below:
```console
$ ./ruby main.rb
```
#### Add new words
You can add new words with write the words into `noun.txt` file in `data` directory.
## Acknowledgments
Thanks to [**@sweetescape**](https://www.sweetescape.com/en) for giving me the opportunity to do this coding test.