Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rafay99-epic/gptinspector
NodeJs and JavaScript App for detecting AI Written Articles.
https://github.com/rafay99-epic/gptinspector
api css ejs html javascript noodejs npm
Last synced: 2 days ago
JSON representation
NodeJs and JavaScript App for detecting AI Written Articles.
- Host: GitHub
- URL: https://github.com/rafay99-epic/gptinspector
- Owner: rafay99-epic
- License: apache-2.0
- Created: 2023-02-18T00:03:44.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T15:41:15.000Z (3 months ago)
- Last Synced: 2024-11-09T11:07:07.526Z (about 1 month ago)
- Topics: api, css, ejs, html, javascript, noodejs, npm
- Language: JavaScript
- Homepage:
- Size: 153 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🚀 GPTInspector - Human vs AI Text Detection
[](https://opensource.org/licenses/MIT)
[](https://nodejs.org/)
👋 Welcome to **GPTInspector**, a simple tool to detect whether the text is written by a human 🧑 or generated by AI 🤖. This project uses the powerful [ChatGPT Detector RoBERTa model](https://huggingface.co/Hello-SimpleAI/chatgpt-detector-roberta) from Hugging Face, integrated through API calls and built with JavaScript, EJS, and Node.js.
## 🌟 Features
- 🌍 **Detect AI-Generated Text**: Quickly analyze if a text was produced by a human or AI.
- 📡 **Hugging Face API**: Leverages Hugging Face's state-of-the-art ChatGPT Detector.
- 💻 **User-friendly Interface**: Powered by EJS templating engine for dynamic and responsive UI.
- ⚡️ **Fast and Efficient**: Lightning-fast detection process with a simple API call.
## 🚧 How It Works
1. 📝 **Submit Text**: Enter a piece of text you want to analyze.
2. 🔍 **Detection**: The text is sent to the Hugging Face model through an API call.
3. 🧑🤝🧑 **Results**: The app tells you if the text is AI-generated or human-written based on model predictions.
## 🔧 Tech Stack
- **JavaScript**: Core programming language for the application.
- **Node.js**: Backend server runtime.
- **EJS**: Templating engine for dynamic rendering.
- **Express.js**: Web framework for Node.js.
- **Hugging Face API**: AI model integration.
## 🚀 Quick Start
1. **Clone the repository**:
```bash
git clone https://github.com/rafay99-epic/GPTInspector.git
cd GPTInspector
```
2. **Install dependencies**:
```bash
npm install
```
3. **Create your API key** from Hugging Face and add it to your environment variables:
```bash
export HUGGINGFACE_API_KEY=your_api_key_here
```
4. **Run the app**:
```bash
npm start
```
5. **Visit** the app in your browser at:
```bash
http://localhost:1313
```
## ⚙️ Configuration
Make sure to configure your Hugging Face API key in the environment. You can set this up in a `.env` file:
```bash
HUGGINGFACE_API_KEY=your_api_key_here
```
## 📂 Project Structure
```bash
📦 GPTInspector
├── 📁 public # Static files (CSS, images)
├── 📁 views # EJS templates for the frontend
├── 📄 app.js # Main Node.js application
├── 📄 package.json # Project dependencies
├── 📄 .env # Environment variables
└── 📄 README.md # Project documentation
```
## 🤝 Contributing
Feel free to submit issues or pull requests. Let's make this project even better! 🎉
## 🛡️ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 💡 Inspiration
Inspired by the need for better understanding of AI-generated content in the growing world of NLP and generative AI. Special thanks to [Hugging Face](https://huggingface.co) for their incredible models!
## 📬 Contact
If you have any questions or feedback, feel free to reach out:
- **GitHub**: [rafay99-epic](https://github.com/rafay99-epic)
- **Email**: [[email protected]](mailto:[email protected])
- **Website**: [rafay99.com](https://www.rafay99.com/contact-me/)
---
Enjoy using GPTInspector! 😊