https://github.com/pravintargaryen/seaslug.js
SeaSlug.js is a lightweight, developer-friendly frontend analytics tool inspired by the ocean's slow-and-steady sea slug. It crawls through your website to gather valuable insights, providing a playful yet powerful alternative to traditional analytics libraries.
https://github.com/pravintargaryen/seaslug.js
analytics frontend javascript
Last synced: 2 months ago
JSON representation
SeaSlug.js is a lightweight, developer-friendly frontend analytics tool inspired by the ocean's slow-and-steady sea slug. It crawls through your website to gather valuable insights, providing a playful yet powerful alternative to traditional analytics libraries.
- Host: GitHub
- URL: https://github.com/pravintargaryen/seaslug.js
- Owner: pravintargaryen
- Created: 2025-01-17T18:06:25.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-17T18:24:00.000Z (4 months ago)
- Last Synced: 2025-01-17T19:34:07.442Z (4 months ago)
- Topics: analytics, frontend, javascript
- Homepage:
- Size: 3.91 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SeaSlug.js 🐌🐠
**SeaSlug.js** is a lightweight, developer-friendly frontend analytics tool inspired by the ocean's slow-and-steady sea slug. It crawls through your website to gather valuable insights, providing a playful yet powerful alternative to traditional analytics libraries.
---
## 🌊 Why SeaSlug.js?
SeaSlug.js is designed for developers who value:
- **Simplicity**: A minimalistic library that’s easy to integrate.
- **Efficiency**: Tracks key metrics without bloating your frontend.
- **Playfulness**: Who says analytics can’t be fun? 🐌
---
## 🚀 Features
- 📊 **Customizable Event Tracking**: Log page views, clicks, and custom events with ease.
- 🌐 **Lightweight**: No heavy dependencies. Tiny, fast, and efficient.
- 🔒 **Privacy-Focused**: Designed with user privacy in mind. No unnecessary data collection.
- 🛠️ **Developer-Friendly API**: A simple and intuitive interface for quick integration.
---
## 🐌 Getting Started
### Installation
You can install SeaSlug.js using npm or yarn:
```bash
npm install seaslug
# or
yarn add seaslug
```
## Usage
Import and initialize SeaSlug.js in your project:
```javascript
import SeaSlug from "seaslug";
// Initialize the library
SeaSlug.init({
trackingId: "YOUR_TRACKING_ID",
debug: true, // Enable debug mode for development
});
// Example: Track a custom event
SeaSlug.track("button_click", {
buttonId: "signup-button",
});
```
## API Reference
1. SeaSlug.init(config)
Initializes the library with your configuration.
### Parameters:
- trackingId (required): Your unique tracking ID.
- debug (optional): Enables logging in the console.
2. SeaSlug.track(eventName, eventData)
Tracks a custom event.
### Parameters:
- eventName (required): Name of the event (e.g., "page_view").
- eventData (optional): Additional data to log with the event.
🛡️ Privacy Policy
SeaSlug.js is built with privacy in mind. It doesn’t collect personally identifiable information (PII) by default and complies with major data protection regulations.
🤝 Contributing
We welcome contributions! If you’d like to contribute to SeaSlug.js, follow these steps:
## Fork the repository.
Create a new branch for your feature or bug fix.
Submit a pull request with a clear description of your changes.
🐠 Credits
SeaSlug.js was inspired by the simplicity and adaptability of sea creatures like the humble sea slug. Special thanks to the developer community for their ideas and support.
📜 License
This project is licensed under the MIT License.
🌟 Support
If you find SeaSlug.js useful, give us a ⭐ on GitHub and spread the word!
### Next Steps:
1. **Replace placeholders** like `YOUR_TRACKING_ID` with actual values or examples if you have them ready.
2. Add a link to the repository’s **LICENSE** file if you’re including one.
3. Add a **logo or badge** if you’d like to give it a branded feel.
Let me know if you’d like further tweaks! 🐌