My First Open-Source Project: Introducing Sentivore, a Simple Text Analyzer

#github

I am incredibly excited to share my very first open-source project with all of you. It's a simple, client-side tool called Sentivore, and I built it to help people quickly analyze text right in their browser.

I wanted to create something practical and useful that didn't require any complex setup or a server. I found that I often needed a quick way to check word counts or find the most frequent words in a block of text, so I decided to build my own solution and make it a free template for others.

What is Sentivore?

Sentivore is a lightweight text analyzer built with pure HTML, CSS, and JavaScript. It provides a clean and functional starting point for anyone who needs to analyze text on the fly.

Key Features:

Word Count: Get an accurate count of all words.
Character Count: See the total number of characters, including spaces.
Sentence Count: A basic algorithm to count sentences.
Average Word Length: Calculates the average length of words in the text.
Top Words: Identifies and lists the top 5 most frequent words.

How to Use This Template

The best part about Sentivore is that it's a template you can use for your own projects! You don't need any special tools. Just clone the repository and open src/index.html in your web browser.

Here's a look at the project structure:

sentivore/
├── src/
│   ├── index.html
│   ├── style.css
│   └── script.js
├── .gitignore
└── LICENSE
└── README.md

Why I Made it Open Source

I chose to make this an open-source template because I believe in the power of shared knowledge and collaboration. This is my first step into the open-source world, and I'd love to learn from all of you.

I've already created some issues labeled good first issue on the GitHub repository to help new contributors get started. Whether you want to fix a bug, suggest a new feature, or improve the documentation, your help is greatly appreciated!