https://github.com/rcdexta/react-scrabble
The word scrabble game written in React.js
https://github.com/rcdexta/react-scrabble
Last synced: 11 months ago
JSON representation
The word scrabble game written in React.js
- Host: GitHub
- URL: https://github.com/rcdexta/react-scrabble
- Owner: rcdexta
- License: mit
- Created: 2017-03-18T15:46:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-17T07:35:24.000Z (about 9 years ago)
- Last Synced: 2025-07-06T19:13:35.352Z (12 months ago)
- Language: JavaScript
- Homepage: https://rcdexta.github.io/react-scrabble/
- Size: 577 KB
- Stars: 11
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# react-scrabble
> The familiar scrabble word game written in React.js
[](https://travis-ci.org/rcdexta/react-scrabble)
[](https://badge.fury.io/js/react-scrabble)
## Usage
The data should be of the following form
```javascript
const data = [
{
word: 'FAR',
hint: '3 letter word that means not so close'
},
{
word: 'PERIODIC',
hint: '8 letter word, your timetable has this'
}
]
```
You can initialise the board by passing the data props
```javascript
import {Board} from 'react-scrabble'
class App extends Component {
render() {
return (
);
}
}r
```
## Development
1. Getting started
```
cd react-scrabble/
yarn install
yarn run storybook
```
### Scripts
1. `npm run lint` : Lint all js files
2. `npm run lintfix` : fix linting errors of all js files
3. `npm run semantic-release` : make a release. Leave it for CI to do.
4. `npm run storybook`: Start developing by using storybook
5. `npm run test` : Run tests. tests file should be written as `*.test.js` and using ES2015
6. `npm run test:watch` : Watch tests while writing
7. `npm run test:cover` : Show coverage report of your tests
8. `npm run test:report` : Report test coverage to codecov.io. Leave this for CI
9. `npm run build`: transpile all ES6 component files into ES5(commonjs) and put it in `dist` directory
10. `npm run docs`: create static build of storybook in `docs` directory that can be used for github pages
Learn how to write stories [here](https://getstorybook.io/docs/basics/writing-stories)
### License
MIT