Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Piterden/vue-crossword

Crossword puzzle builder VueJS application.
https://github.com/Piterden/vue-crossword

crossword crossword-generator crossword-puzzle grid-generator puzzle vue

Last synced: 3 months ago
JSON representation

Crossword puzzle builder VueJS application.

Host: GitHub
URL: https://github.com/Piterden/vue-crossword
Owner: Piterden
License: mit
Created: 2017-11-25T05:33:04.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2023-03-04T02:31:40.000Z (over 1 year ago)
Last Synced: 2024-06-20T05:03:31.656Z (5 months ago)
Topics: crossword, crossword-generator, crossword-puzzle, grid-generator, puzzle, vue
Language: JavaScript
Homepage: https://piterden.github.io/vue-crossword
Size: 3.05 MB
Stars: 66
Watchers: 7
Forks: 17
Open Issues: 30
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Vue Crossword

[![Travis (.com) branch](https://img.shields.io/travis/com/Piterden/vue-crossword/master.svg?style=for-the-badge&logo=travis-ci)](https://travis-ci.com/Piterden/vue-crossword) [![awesome-vue](https://img.shields.io/static/v1.svg?label=Vue.JS&message=AWESOME&logo=vue.js&style=for-the-badge&color=ff69b4)](//github.com/vuejs/awesome-vue) [![GitHub stars](https://img.shields.io/github/stars/Piterden/vue-crossword.svg?style=for-the-badge&logo=github)](https://github.com/Piterden/vue-crossword/stargazers) [![GitHub forks](https://img.shields.io/github/forks/Piterden/vue-crossword.svg?style=for-the-badge&logo=git)](https://github.com/Piterden/vue-crossword/network) [![GitHub watchers](https://img.shields.io/github/watchers/Piterden/vue-crossword.svg?logo=gitter&style=for-the-badge)](https://github.com/Piterden/vue-crossword/watchers)

A Vue.js based crossword puzzle builder and filler front-end application.

![1547090130650](https://raw.githubusercontent.com/Piterden/vue-crossword/master/preview01.png)

## Demo

[**DEMO** _Russian Words Database_](https://piterden.github.io/vue-crossword)

## Features and ToDo

- [x] Supports 2-31 symbols words lengths.

- [x] Supports any grid size.

- [x] Random symmetric grid generator.

- [x] Automatic calculation of required to fill letter cells and clues numeration.

- [x] Words suggestions from API depending on length and filled letters.

- [x] Clues suggestions for filled words from API.

- [x] Add different types of symmetry to grid generation.

- [x] Add analyzer and smart corrector for generated grids (to control words length).

- [X] Automatic generation of full filled crossword.

- [ ] Make a print version.

- [ ] User login (OAuth2).

- [ ] Save built crosswords.

- [ ] Add and save new words and clues.

- [ ] Search within suggested words by added letters.

- [ ] Search in clues of suggested words.

- [ ] Add taxonomy for clues.

- [ ] Improve the logic of API queries.

- [ ] Fix mobile version.

## Usage

1. Find a grid with only white and black squares.

2. Press `Fill words`.

3. Press `Auto fill`.

There are a few simple rules:

- Generated forms of vertical and horizontal questions allow you to fill cells inside them with letters.

- Grid cells do not allow you to fill them with letters but you can edit a grid geometry by clicking on them.

- You can change the size of a grid pressing the `Change Size` button which enables *the size change mode*. In this mode requests to the API are temporarily disabled and suggesting words would be updated on exit to the normal edit mode.

- When word is filled, you could select the clue or enter your one. The cells of filled words are marked with a green color.

## Build Setup

```bash

# install dependencies

npm i

# serve with hot reload at localhost:8080

npm run serve

# build for production with minification

npm run build

# lint project

npm run lint

```

## Built With

- [VueJS](https://vuejs.org/) - The Progressive JavaScript Framework.

- [CodeSandbox](https://codesandbox.io) - The online code editor for ...

- [Words API](https://github.com/Piterden/crosswords-module) - Words API repository.

## Contributing

PR's are appreciated.

[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/0)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/0)[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/1)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/1)[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/2)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/2)[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/3)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/3)[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/4)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/4)[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/5)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/5)[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/6)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/6)[![](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/images/7)](https://sourcerer.io/fame/Piterden/Piterden/vue-crossword/links/7)

## Authors

- **Denis Efremov** - *Code|Idea* - [Piterden](https://github.com/Piterden)

- **mvrlin** - *Help with styles* - [mvrlin](https://github.com/mvrlin)

- **kolay** - *Code|Improvements* - [kolay-v](https://github.com/kolay-v)

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/Piterden/vue-crossword/blob/master/LICENSE) file for details.

## Donate

- **BTC** `3F275vPSCvYW19MHZqSjw79fEwwU4MbTgV`

- **LTC** `MGMCQB3QAcrSBjU3eGJviqB2J2f5BNVRGr`

- **DOGE** `D5m69FRDGEn3G3xuakvqTxUpGVt6NegKJp`