WordStorm

WordStorm is a web-based game where players guess a secret word based on its similarity to other words. The game provides feedback on the rank and progress of each guess, helping players to narrow down the correct word.

Table of Contents

• WordStorm
  • Table of Contents
  • Installation
  • Setup Guide
    • Word Generator
    • Django
  • Usage
  • Screenshots
  • Credits
  • License

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/wordstorm.git
   cd wordstorm

2. Create a virtual environment:

   python -m venv env

3. Activate the virtual environment:

   • On Windows:

     .\env\Scripts\activate

   • On macOS and Linux:

     source env/bin/activate

4. Install the dependencies:

   pip install -r requirements.txt

Setup Guide

Word Generator

1. Download the word embeddings file from the Official GLoVe website: glove.6B.zip. And store in the WordStorm directory.

   curl -O https://downloads.cs.stanford.edu/nlp/data/glove.6B.zip
   unzip glove.6B.zip

2. Check if the glove.6B.300d.txt file is present in the WordStorm/glove.6B directory.

3. Generate the random word to guess and its ranking to other words:

   python word_generator/big_data.py
   python word_generator/ranks.py

   The script will generate a random word from the glove.6B.300d.txt file and rank it against other words based on their similarity.

Django

1. Apply database migrations:

   python manage.py migrate

2. Run the development server:

   python manage.py runserver

3. Access the application:

   Open your web browser and navigate to http://127.0.0.1:8000.

Usage

1. Enter your guess:

   Type a word into the input field and click the "Submit" button.

2. View feedback:

   The application will display the rank and progress of your guess. Keep guessing to improve your rank and find the correct word.

3. View previous guesses:

   The application will display a list of your previous guesses along with their ranks and progress bars.

Screenshots

Home page

Different guesses and their ranks compared to the answer which is "disco"

Display when the correct word with rank 1 is guessed

Credits

• Developer: Shivi Sharma
• Contributors: @shivisharma1209
• Special Thanks: @phantsure

License

This project is licensed under the MIT License - see the LICENSE file for details.