Update: WordWiz now utilizes the WordWiz-API for fetching word definitions in real-time. Ensure that the WordWiz-API server is running and accessible at http://localhost:8080 for the application to function correctly.
WordWiz is a web application built on Object-Oriented Programming principles that provides instant word definitions as you type, offering an effortless way to explore language in real-time. With a user-friendly interface and multiple pages, WordWiz simplifies the process of discovering and expanding your vocabulary.
- Real-time Definitions: Get instant definitions for any English word as you type.
- User-Friendly Interface: Enjoy a simple and intuitive interface for seamless user experience.
- Multiple Pages: Includes home, about, and dictionary pages for comprehensive functionality.
- Custom Logger: Easily add a custom logger to track and manage application logs efficiently. Users are free to adjust custom logging settings by modifying the
AppLoggerclass according to their requirements.
- justpy: A library for building interactive web applications.
- pandas: A data manipulation and analysis library.
- requests: A library for making HTTP requests.
- logging: A module for tracking events that happen when software runs.
- inspect: A module for retrieving live object information.
- Clone the repository.
- Ensure Python 3.x is installed.
- Install the required dependencies using
pip install -r requirements.txt. - Place your additional data in the
resources/data.csvfile to expand the dictionary. - Run the script using
python main.py.
- Run the script using
python main.py. - Access the application in your web browser at http://localhost:8000.
- Navigate between the home, about, and dictionary pages to explore the functionality.
- Use the dictionary page to instantly discover word definitions.
WordWiz now utilizes the WordWiz-API for fetching word definitions in real-time. Ensure that the WordWiz-API server is running and accessible at http://localhost:8080 for the application to function correctly. For more details about the WordWiz-API, visit its repository on WordWiz-API.
Explore the WordWiz-API documentation to understand its endpoints and usage. Access the API documentation at http://localhost:8000/api-docs.
Feel free to explore and enjoy the WordWiz web application!
Contributions are welcome! Here are some ways you can contribute to the project:
- Report bugs and issues
- Suggest new features or improvements
- Submit pull requests with bug fixes or enhancements
This project is licensed under the MIT License, which grants permission for free use, modification, distribution, and sublicense of the code, provided that the copyright notice (attributed to emads22) and permission notice are included in all copies or substantial portions of the software. This license is permissive and allows users to utilize the code for both commercial and non-commercial purposes.
Please see the LICENSE file for more details.
