Skip to content

Latest commit

 

History

History
236 lines (167 loc) · 8.16 KB

File metadata and controls

236 lines (167 loc) · 8.16 KB

WordWizard 🧙‍♂️

A powerful text manipulation tool built with React and Vite for the modern web.


Live Demo License: MIT PRs Welcome GitHub Stars GitHub Forks GitHub Issues

Live DemoReport BugRequest Feature


📋 Table of Contents


🎯 About

WordWizard is a modern, feature-rich text manipulation tool that empowers users to efficiently analyze and transform text content. Built with performance and user experience in mind, it provides a comprehensive suite of text processing features with an intuitive interface.

Why WordWizard? Description
🚀 Lightning Fast Built with React + Vite for optimal performance.
🎨 Customizable Multiple themes and appearance options.
📱 Responsive Works seamlessly across all devices.
🔐 Privacy-Focused All text processing happens locally in your browser.

⭐ Key Features

Category Feature
✍️ Text Manipulation • Case conversion (UPPERCASE, lowercase) • Smart space management • Real-time text analysis • One-click copy to clipboard
📊 Analysis Tools • Detailed word & character counts • Character frequency analysis • Reading time estimation • Text complexity metrics
🎨 User Experience • Dark/Light mode with multiple themes • Instant results with no page reloads • Auto-save functionality • Smooth transitions

🛠️ Tech Stack

Category Technologies
Core React 18, Vite
UI Components Tailwind CSS, CSS Modules
State Management React Context API
Dev Tools ESLint, Prettier, Husky, lint-staged
Testing Jest, React Testing Library

🚀 Getting Started

Prerequisites

  • Node.js: v16 or higher
  • npm: v7 or higher

Installation Steps

  1. Forking the Repository:

    If you’d like to contribute to WordWizard, start by creating your own copy of the repository. Go to the WordWizard GitHub repository: https://github.com/palchhinparihar/WordWizard

    Click on the “Fork” button (top-right corner of the page). This creates a personal copy of the repository under your GitHub account.

  2. Clone your forked repository:

    git clone https://github.com/palchhinparihar/WordWizard.git
    cd WordWizard
  3. Add the upstream remote (original repo)

    git remote add upstream https://github.com/palchhinparihar/WordWizard.git
  4. Sync your fork with the main repo:

    git pull upstream main
  5. Install dependencies:

    npm install
  6. Add .env file:

    Rename the provided .env-example file to .env and ensure it contains the following line:

    VITE_LANUGAGETOOL_API_URL=https://api.languagetool.org/v2/check

    Note: Never commit your personal .env file to GitHub. It should remain local for security reasons.

  7. Create a New Branch

    Before making any changes, create a new branch for your contribution:

    git checkout -b <your-branch-name>

    Use a descriptive branch name, such as:

    -fix/navbar-animation -feature/add-dark-mode-toggle -docs/update-readme

  8. Start the development server:

    npm run dev

Available Scripts

  • npm run dev: Start development server.
  • npm run build: Create a production build.
  • npm run test: Run the test suite.
  • npm run lint: Lint the codebase.

📂 Project Structure

wordwizard/
├── public/                  # Static assets
├── src/
│   ├── assets/              # Images, fonts, etc.
│   ├── components/          # React components
│   │   ├── About.jsx
│   │   ├── Alert.jsx
│   │   ├── BackToTopButton.jsx
│   │   ├── DialogBox.jsx
│   │   ├── Dropdown.jsx
│   │   ├── Footer.jsx
│   │   ├── Navbar.jsx
│   │   ├── MobileMenu.jsx
│   │   ├── SummaryCard.jsx
│   │   ├── TextForm.jsx
│   │   ├── Toolbar.jsx
│   │   └── Welcome.jsx
│   ├── data/                # Static data
│   │   ├── accordionItems.js
│   │   ├── navbarContent.js
│   │   ├── textUtils.js
│   │   └── themes.js
│   ├── i18n/               # Internationalization
│   │   ├── en.json
│   │   ├── hi.json
│   │   └── index.jsx
│   ├── App.jsx             # Main App component
│   ├── index.css           # Main App style
│   ├── main.jsx            # Entry point
│   └── utils.js            # Utility functions
├── .env-example            # Environment variables
├── index.html              # HTML entry point
├── package.json            # Dependencies and scripts
├── tailwind.config.js      # Tailwind configuration
└── vite.config.js          # Vite configuration

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for more details on how to get started.


👥 Contributors

Thanks to these wonderful people who have contributed to WordWizard:

Contributors


⚖️ License

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


📞 Contact

Any doubt? Send here

Project Lead

Palchhin GitHub

Project Links


Made with ❤️ by the WordWizard Team.