CrossGen is a desktop application for generating crossword puzzles. The application allows you to create crossword layouts based on specific topics, with customizable word counts and clue styles (including cryptic, humorous, and pessimistic clues).
The application uses a pipeline approach to generate crosswords:
- Word retrieval - Generates words related to a chosen topic
- Clue generation - Creates clues for each word in the selected style
- Layout generation - Arranges words in a crossword grid
- Node.js (v14.0 or higher)
- npm (v6.0 or higher)
- Electron
- LM Studio with a local API server running at http://127.0.0.1:1234
- Clone the repository:
git clone https://github.com/sam0ed/CourseWork5sem.git
cd CourseWork5sem
- Install dependencies:
# Install main application dependencies
npm install
# Install React frontend dependencies
cd renderer
npm install
cd ..
-
Start LM Studio and set up the local API server
-
Start the React development server:
# In the renderer directory
cd renderer
npm start
- In a separate terminal, start the Electron application:
# In the root directory
npm start
The application should launch automatically and connect to the React frontend running on http://localhost:3000.
To create a production build:
# Build the React frontend
cd renderer
npm run build
# Package the Electron application
cd ..
npm run make
The packaged application will be available in the out
directory.
- Generate crosswords on any topic
- Three crossword sizes: small, medium, and large
- Three clue styles: cryptic, humorous, and pessimistic
- Interactive crossword grid
- Word generation with AI assistance