A lightning-fast, user-friendly web application built with React and Vite that allows you to analyze text, count words, characters, and sentences, and get instant insights into your writing. Perfect for content creators, students, and anyone needing quick text metrics.
- ✨ Features
- 🖼️ GIF Demo
- 🚀 live preview
- 🛠️ Technologies Used
- ⚙️ Installation
▶️ Usage- 📂 Project Structure
- 🤝 Contributing
- 📄 License
- 📧 Contact
- 📝 Real-time Text Input: Instantly see changes as you type.
- 🔢 Word & Character Count: Get accurate counts for words and characters.
- 📈 Readability Statistics: (Potentially, based on
Stats.jsx) Provides insights like average word length, sentence count. ⚠️ Content Warnings: (Based onWarning.jsx) Highlights potential issues or areas for improvement in the text.- 🎨 Clean & Intuitive UI: A minimalist design for a seamless user experience.
- ⚡ Blazing Fast Performance: Powered by Vite for rapid development and optimized production builds.
Check out a quick demonstration of the application in action:
- You can also try the live version: ---> Here
- React: A JavaScript library for building user interfaces.
- Vite: A next-generation frontend tooling that provides an extremely fast development environment and optimized builds.
- pnpm: A fast, disk-space efficient package manager.
- JavaScript: The core programming language.
- CSS: For styling the application.
- ESLint: For maintaining code quality and consistency.
- To get a local copy of this project up and running on your machine, follow these simple steps.
-
Make sure you have Node.js installed (which includes npm), and it's recommended to install pnpm globally for this project:
npm install -g pnpm
-
Clone the repository:
git clone https://github.com/aminetiouk/word-analytics cd word-analytics -
Install dependencies using pnpm:
pnpm install
- Once the installation is complete, you can run the project in development mode or build it for production.
To start the development server with hot-reloading:
pnpm dev- To build the optimized static assets for production, which will generate a dist folder:
pnpm build.
├── LICENSE # Project license file
├── README.md # This README file
├── index.html # Main HTML entry point
├── src/ # All source code for the application
│ ├── assets/ # Static assets like images and GIFs
│ │ ├── counter.svg
│ │ └── screen-recording.gif # Project demo GIF
│ ├── components/ # Reusable React components
│ │ ├── App.jsx
│ │ ├── Background.jsx
│ │ ├── Footer.jsx
│ │ ├── H1.jsx
│ │ ├── H2.jsx
│ │ ├── Header.jsx
│ │ ├── Main.jsx
│ │ ├── Stats.jsx # handles text statistics
│ │ ├── Textarea.jsx # The main text input area
│ │ └── Warning.jsx # Displays warnings or insights
│ ├── index.css # Global CSS styles
│ ├── lib/ # Utility functions or constants
│ │ └── constants.js
│ └── main.jsx # Main React application entry point
└── vite.config.js # Vite configuration file for bundling-
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
-
If you have a suggestion that would make this project better, please fork the repo and create a pull request. Don't forget to give the project a star! ⭐
- Fork the Project
- Create your Feature Branch:
git checkout -b feature/AmazingFeature
- Commit your Changes:
git commit -m 'Add some AmazingFeature' - Push to the Branch:
git push origin feature/AmazingFeature
- Open a Pull Request
- Distributed under the MIT License. See the LICENSE file for more information.
- Name - @aminetiouk
- Project Link: @word-analytics