Skip to content

README.md

Latest commit

 

History

History
81 lines (57 loc) · 3.42 KB

README.md

File metadata and controls

81 lines (57 loc) · 3.42 KB

Dictionary Web App

A lightweight, interactive JavaScript dictionary web app built with HTML, CSS, and vanilla JavaScript. Search for word definitions instantly with a clean, responsive interface and a dark mode toggle for enhanced user experience. Perfect for developers, learners, and anyone looking to integrate or customize an online dictionary tool .

JavaScript HTML5 CSS3 License PRs Welcome Open Source

Features

  • Instant Word Search : Quickly look up word definitions with a simple, intuitive interface.
  • Dark Mode Toggle : Switch between light and dark themes for comfortable viewing.
  • Responsive Design : Works seamlessly across desktops, tablets, and mobile devices.
  • Lightweight & Fast : Built with vanilla JavaScript, HTML5, and CSS3 for optimal performance.
  • Open Source : Fork, contribute, or customize to suit your needs!

Demo

Try the live app here

Installation

  1. Clone the repository: 
    git clone https://github.com/NickFrost2/Dictionary.git
  2. Navigate to the project directory: 
    cd Dictionary
  3. Open index.html in a browser to run the app locally, or serve it using a local server (e.g., with VS Code's Live Server extension).

Usage

  • Enter a word in the search bar to retrieve its definition.
  • Toggle between light and dark modes using the theme switcher.
  • Explore the code to customize or extend functionality (e.g., add new APIs or features).

Project Structure

Dictionary/
├── index.html        # Main HTML file for the app
├── style.css         # Styling for the app, including dark mode
├── script.js         # JavaScript logic for search and theme toggle
├── .gitattributes    # Git configuration for file handling
├── LICENSE           # MIT License file
├── README.md         # Project documentation (this file)

Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes and commit (git commit -m "Add your feature").
  4. Push to your branch (git push origin feature/your-feature).
  5. Open a pull request.

See CONTRIBUTING.md for more details.

License

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

Acknowledgements

  • Built with ❤️ as part of the JSPlayz project.
  • Inspired by the need for simple, accessible dictionary tools for developers and learners.

Contact

Have questions or suggestions? Reach out to Nick Frost or open an issue!

Keywords : JavaScript dictionary, web app, dark mode, responsive design, vanilla JS, HTML5, CSS3, open source, dictionary API, frontend development