crossword-web-app

Preview

Description

This is a Automatic Crossword generator web application. Basically, speciallized on filling in a theme crossword grid with words and follows all the basic known rules.

Install

Python

  $ python3 -m pip install -r requirements.txt

Javascript

Move terminal to cross_app folder

  $ cd app/frontend/cross_app

Install packages

  $ npm install 

or with yarnpkg

  $ yarn install

Usage

1. Backend
   Activate virtual environment

     $ source bin/activate

   Run server

     $ flask run

   Exit environment

     $ deactivate

2. Frotend
   Run vue app locally

     $ npm run serve

   or with yarnpkg

     $ yarn serve

Docs

Additionaly, you may have in mind read all the rules and other relative docs in the docs folder

• basic rules - βασικοί κανόνες
• process structure - δομή κώδικα

Printing

Present: .pdf

Future: .puz, LateX

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Contributions affect only the effort of generating the grid with words. After that all the PRs wil be ignored. The Last step certainly is the json translated in the API. Frontend is just for viewing.

Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
2. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.