@revijs/core 0.1.4 → 0.1.7

package/LICENSE

@@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+

package/README.md

@@ -1,7 +1,7 @@
 # ⚡ ReviJs 🧙‍♂️
 
-[![npm version](https://img.shields.io/npm/v/revijs?style=flat-square&color=blueviolet)](https://www.npmjs.com/package/@revijs/core)
-[![npm downloads](https://img.shields.io/npm/dm/revijs?style=flat-square&color=brightgreen)](https://www.npmjs.com/package/@revijs/core)
+[![npm version](https://img.shields.io/npm/v/@revijs/core?style=flat-square&color=blueviolet)](https://www.npmjs.com/package/@revijs/core)
+[![npm downloads](https://img.shields.io/npm/dm/@revijs/core?style=flat-square&color=brightgreen)](https://www.npmjs.com/package/@revijs/core)
 [![MIT License](https://img.shields.io/badge/license-MIT-green?style=flat-square)](LICENSE)
 [![Made by AlphaBotz](https://img.shields.io/badge/🤖%20Made%20by-AlphaBotz-blueviolet?style=flat-square)](https://github.com/TeamAlphabotz)
 [![Node.js](https://img.shields.io/badge/Node.js-18+-brightgreen?style=flat-square&logo=node.js)](https://nodejs.org/)
@@ -11,11 +11,24 @@
 
 ---
 
+## 🔗 Quick Links
+
+- 📖 [Full Documentation](https://teamalphabotz.github.io/Revijs/)
+- 🚀 [Getting Started](https://teamalphabotz.github.io/Revijs/#start)
+- ⚙️ [Configuration](https://teamalphabotz.github.io/Revijs/#config)
+- 🔌 [API Reference](https://teamalphabotz.github.io/Revijs/#api)
+- 🧩 [Middleware](https://teamalphabotz.github.io/Revijs/#middleware)
+- 💡 [Examples](https://teamalphabotz.github.io/Revijs/#examples)
+- 🐙 [GitHub Repository](https://github.com/TeamAlphabotz/Revijs)
+- 📦 [npm Package](https://www.npmjs.com/package/@revijs/core)
+
+---
+
 ## 🎯 What's ReviJs?
 
 Tired of your fancy React/Vite app being invisible to Google? 😱 ReviJs is here to save the day!
 
-ReviJs **spins up a headless browser**, visits every route in your app, waits for data to load, and captures the fully-rendered HTML. Then it serves that pre-baked HTML to search engines while your users still get the smooth SPA experience. 
+ReviJs **spins up a headless browser**, visits every route in your app, waits for data to load, and captures the fully-rendered HTML. Then it serves that pre-baked HTML to search engines while your users still get the smooth SPA experience.
 
 It's like having your cake and eating it too. 🍰
 
@@ -23,41 +36,26 @@ It's like having your cake and eating it too. 🍰
 
 ## ⚙️ Requirements
 
-Before you summon the ReviJs wizard, make sure you have these installed:
-
-### System Requirements
-- **Node.js**: `>=18.0.0` (LTS recommended)
-- **npm**: `>=9.0.0` or **yarn** / **pnpm**
-- **Operating System**: macOS, Linux, Windows
-
-### Project Requirements
-- A **React** or **Vite** project
-- Built output in a `dist/` folder (or customizable)
-- Node-like environment for running the CLI
-
-### Package Dependencies
-
-The `@revijs/core` package automatically installs its dependencies:
-- **puppeteer** (headless browser automation)
-- **express** (local server)
-- **fast-glob** (route discovery)
-- **dotenv** (env config)
+- **Node.js**: `>=18.0.0`
+- **npm**: `>=9.0.0` or yarn / pnpm
+- **OS**: macOS, Linux, Windows
+- A built React / Vite / Vue / Svelte app
 
 ---
 
 ## 🚀 Quick Start (30 seconds!)
 
 ```bash
-# 1️⃣  Install the magic
-npm install revijs
+# 1️⃣  Install
+npm install @revijs/core
 
-# 2️⃣  Initialize config (interactive)
+# 2️⃣  Initialize config
 npx revijs init
 
-# 3️⃣  Build your app normally
+# 3️⃣  Build your app
 npm run build
 
-# 4️⃣  Let the prerendering begin! 🎆
+# 4️⃣  Prerender!
 npx revijs
 ```
 
@@ -67,289 +65,95 @@ npx revijs
 
 ## 🛠️ Configuration (`revi.config.js`)
 
-Customize your prerendering experience:
-
 ```js
 export default {
-  // 🌍 Routes to prerender
-  routes: ['/', '/about', '/blog/post-1', '/products'],
-  
-  // 🎮 Rendering engine
+  routes: ['/', '/about', '/blog/post-1'],
   engine: 'browser',       // 'browser' | 'advanced' | 'ssr'
-  
-  // 📁 Output settings
   outputDir: 'dist-prerendered',
   distDir: 'dist',
-  
-  // ⏱️ Wait for data (adjust if routes are slow)
-  waitFor: 1200,           // milliseconds after network idle
-  
-  // 🕵️ Browser settings
+  waitFor: 1200,           // ms after network idle
   headless: true,
   port: 4173,
-  
-  // 🎯 Optional: exclude routes
-  exclude: ['/admin', '/dashboard'],
-  
-  // 📸 Optional: capture screenshots
-  screenshots: false,
 };
 ```
 
-### Config Options Explained
-| Option | Type | Default | What It Does |
-|--------|------|---------|--------------|
-| `routes` | Array | `[]` | Routes to prerender (required!) |
-| `engine` | String | `'browser'` | How to render (browser is safest) |
-| `outputDir` | String | `'dist-prerendered'` | Where to save static HTML |
-| `distDir` | String | `'dist'` | Your built app location |
-| `waitFor` | Number | `1200` | ms to wait after network idle |
-| `headless` | Boolean | `true` | Run browser hidden? |
-| `port` | Number | `4173` | Local server port |
-
 ---
 
-## 🎪 How the Magic Works (Under the Hood)
-
-```
-┌─────────────────────────────────────────────────────┐
-│  You run: npm run build                             │
-│  Then: npx revijs                                   │
-└─────────────────┬───────────────────────────────────┘
-                  │
-        ┌─────────▼──────────┐
-        │ Start Local Server │
-        └���────────┬──────────┘
-                  │
-        ┌─────────▼──────────────────┐
-        │ Launch Headless Browser 🤖 │
-        └─────────┬──────────────────┘
-                  │
-        ┌─────────▼────────────────────────┐
-        │ Visit Each Route in Your App     │
-        │ (/, /about, /blog/post-1, etc)   │
-        └─────────┬────────────────────────┘
-                  │
-        ┌─────────▼──────────────────────┐
-        │ Wait for All Data to Load ⏳   │
-        │ (Network Idle + waitFor ms)     │
-        └─────────┬──────────────────────┘
-                  │
-        ┌─────────▼──────────────────────┐
-        │ Capture Full Rendered HTML 📸  │
-        └─────────┬──────────────────────┘
-                  │
-        ┌─────────▼──────────────────────┐
-        │ Write Static Files to Disk 💾  │
-        │ (dist-prerendered/)             │
-        └─────────┬──────────────────────┘
-                  │
-        ┌─────────▼──────────────────────┐
-        │ 🎉 Done! Static HTML Ready     │
-        └──────────────────────────────────┘
-```
-
----
-
-## 🧩 Middleware Magic (Serve Bots vs Humans)
-
-Automatically detect bots and serve them pre-rendered HTML:
-
-```js
-import express from 'express';
-import { createMiddleware } from 'revijs';
-
-const app = express();
+## 🤖 Supported Bots
 
-// 🤖 ReviJs middleware intercepts bot requests
-app.use(createMiddleware({ 
-  prerenderedDir: 'dist-prerendered',
-  botDetection: true, // Auto-detect crawlers
-}));
+ReviJs automatically detects and serves prerendered HTML to all major crawlers.
 
-// Serve your SPA normally
-app.use(express.static('dist'));
+### Most Common
+| Bot | Company | Type |
+|-----|---------|------|
+| `googlebot` | Google | Search engine |
+| `bingbot` | Microsoft | Search engine |
+| `gptbot` | OpenAI | AI crawler |
+| `claudebot` | Anthropic | AI crawler |
+| `perplexitybot` | Perplexity AI | AI crawler |
+| `facebookexternalhit` | Meta | Social preview |
+| `twitterbot` | X (Twitter) | Social preview |
+| `linkedinbot` | LinkedIn | Social preview |
+| `yandexbot` | Yandex | Search engine |
+| `baiduspider` | Baidu | Search engine |
 
-app.listen(4173, () => {
-  console.log('🚀 Server running with ReviJs magic!');
-});
-```
+<details>
+<summary>View all supported bots</summary>
 
-**What happens:**
-- 🤖 **Bot visits** → Serves prerendered static HTML (instant SEO)
-- 👤 **User visits** → Serves your React app (smooth SPA experience)
-- 🎯 **Win-win!**
+### Search Engines
+`googlebot` `google-inspectiontool` `bingbot` `yandexbot` `baiduspider` `duckduckbot` `slurp` `sogou` `exabot` `rogerbot` `mj12bot` `dotbot` `ia_archiver`
 
----
+### AI / LLM Crawlers
+`gptbot` `chatgpt-user` `claudebot` `claude-web` `anthropic-ai` `perplexitybot` `cohere-ai` `amazonbot` `applebot`
 
-## 🤖 Programmatic API (For Advanced Wizards)
+### SEO Tools
+`ahrefsbot` `semrushbot` `facebot`
 
-Use ReviJs in your own scripts:
-
-```js
-import { prerender } from 'revijs';
-
-// Programmatically prerender
-const result = await prerender({
-  routes: ['/', '/about', '/contact'],
-  outputDir: 'dist-prerendered',
-  distDir: 'dist',
-  engine: 'browser',
-  headless: true,
-  waitFor: 1500,
-  onProgress: (route) => console.log(`✅ Prerendered: ${route}`),
-  onError: (route, error) => console.error(`❌ Error on ${route}:`, error),
-});
+### Social & Preview
+`facebookexternalhit` `twitterbot` `linkedinbot` `slackbot` `discordbot` `telegrambot` `whatsapp` `vkshare` `pinterest` `tumblr` `flipboard`
 
-console.log(`✨ Prerendered ${result.count} routes!`);
-```
+### Generic Signals
+`spider` `crawler` `scraper`
 
----
+</details>
 
-## 🔥 Real-World Examples
+> Want to add a custom bot? Use the programmatic API — `isBot()` and `detectBot()` are fully exported.
 
-### Example 1: Blog Site
-```js
-export default {
-  routes: ['/', '/blog', '/blog/post-1', '/blog/post-2', '/about'],
-  engine: 'browser',
-  waitFor: 2000, // Wait longer for blog content
-};
-```
+## 🧩 Middleware
 
-### Example 2: E-Commerce
 ```js
-export default {
-  routes: ['/', '/products', '/products/item-1', '/cart', '/checkout'],
-  engine: 'browser',
-  waitFor: 1500,
-  exclude: ['/admin', '/dashboard'],
-};
-```
+import express from 'express';
+import { createMiddleware } from '@revijs/core';
 
-### Example 3: SaaS App
-```js
-export default {
-  routes: ['/'],
-  engine: 'browser',
-  waitFor: 1200,
-  exclude: ['/app/*', '/dashboard/*'],
-};
+const app = express();
+app.use(createMiddleware({ prerenderedDir: 'dist-prerendered' }));
+app.use(express.static('dist'));
+app.listen(3000);
 ```
 
 ---
 
-## 💡 Pro Tips & Tricks
+## 🤖 Programmatic API
 
-### 🎯 Tip 1: Optimize Your Routes
 ```js
-// ❌ Too slow: Pre-rendering every possible page
-routes: ['/blog/post-' + Array.from({length: 10000}, (_, i) => i)],
-
-// ✅ Better: Pre-render the important ones
-routes: ['/', '/blog', '/blog/popular-posts', '/about', '/contact'],
-```
-
-### ⏱️ Tip 2: Adjust `waitFor` for Your App
-```js
-// If your data loads fast:
-waitFor: 800,
-
-// If you fetch from slow APIs:
-waitFor: 3000,
+import { prerender } from '@revijs/core';
 
-// Pro: Add a loading flag to your app
-if (document.body.dataset.loaded === 'true') {
-  // Tell ReviJs we're ready
-}
-```
-
-### 🔄 Tip 3: Combine with Build Scripts
-```json
-{
-  "scripts": {
-    "build": "vite build",
-    "prerender": "npm run build && revijs",
-    "deploy": "npm run prerender && netlify deploy"
-  }
-}
+await prerender({
+  routes: ['/', '/about'],
+  outputDir: 'dist-prerendered',
+});
 ```
 
 ---
 
-## 🚨 Troubleshooting
-
-| Problem | Solution |
-|---------|----------|
-| ⏳ Routes timing out | Increase `waitFor` value (try 2000) |
-| 🚫 Routes not found | Check `routes` array in config |
-| 💾 No output files | Ensure `distDir` exists and is built |
-| 🤖 Browser won't start | Update Puppeteer: `npm install puppeteer@latest` |
-| 🔴 Port already in use | Change `port` in config or kill process |
-
----
-
-## 🎬 Features Roadmap
-
-- ✅ Browser rendering
-- ✅ Express middleware
-- ✅ Programmatic API
-- 🚀 Advanced rendering mode
-- 🚀 SSR engine support
-- 🚀 Incremental prerendering
-- 🚀 Cache layer
-
----
-
-## 👨‍💻 Meet the Team
-
-This project is made with ❤️ by the AlphaBotz crew:
+## 👨‍💻 Team
 
 | Name | Role | Link |
 |------|------|------|
 | **Utkarsh Dubey** 🧑‍💻 | Core Developer | [@utkarshdubey2008](https://github.com/utkarshdubey2008) |
 | **Adarsh** 🚀 | Core Developer | [@TeamAlphabotz](https://github.com/teamalphabotz) |
 
-### 🤝 Join the Community!
-
-- 📢 **Main Channel**: [@thealphabotz](https://t.me/thealphabotz)
-- 💬 **Chat Group**: [@alphabotzchat](https://t.me/alphabotzchat)
-- 👤 **Alter**: [@alter69x](https://t.me/alter69x)
-- 🎨 **Akane**: [@akanesakuramori](https://t.me/akanesakuramori)
-
-**We're always hanging out on Telegram!** Come for the bots, stay for the vibes. 🎉
-
----
-
-## 📊 Stats & Performance
-
-| Metric | Benefit |
-|--------|---------|
-| **SEO Score** | 📈 100/100 (with prerendering) |
-| **Initial Load** | ⚡ Instant (static HTML) |
-| **User Experience** | 🎯 Smooth SPA after load |
-| **Cloud Cost** | 💰 Zero (local-first) |
-| **Setup Time** | ⏱️ 30 seconds |
-
----
-
-## 📚 More Resources
-
-- 🐙 [GitHub Repository](https://github.com/TeamAlphabotz/Revijs)
-- 📦 [npm Package](https://www.npmjs.com/package/@revijs/core)
-- 💬 [Discord Community](#) *(coming soon)*
-- 📖 [Full Documentation](#) *(coming soon)*
-
----
-
-## 🎁 Why You'll Love ReviJs
-
-✨ **Easy Setup** — 30 seconds to get started  
-🚀 **No Cloud** — Everything runs locally  
-⚡ **Lightning Fast** — Pre-built static HTML  
-🎯 **SEO Friendly** — Search engines see full HTML  
-🔧 **Flexible** — Works with React, Vue, Svelte, etc.  
-💚 **Free & Open** — MIT License, community-driven  
+💬 **Telegram**: [@thealphabotz](https://t.me/thealphabotz) · [@alphabotzchat](https://t.me/alphabotzchat)
 
 ---
 
@@ -359,12 +163,6 @@ This project is made with ❤️ by the AlphaBotz crew:
 
 ---
 
-## 🌟 If You Like It...
-
-Please give us a ⭐ on [GitHub](https://github.com/TeamAlphabotz/Revijs)!
-
----
-
 <div align="center">
 
 ### Made with 💜 by AlphaBotz

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@revijs/core",
-  "version": "0.1.4",
+  "version": "0.1.7",
   "description": "Local-first SPA prerender CLI — convert React/Vite apps into SEO-friendly static HTML",
   "type": "module",
   "main": "./src/index.js",

package/src/cli.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 import { Command } from 'commander';
 import pc from 'picocolors';
 import { loadConfig } from './config.js';

package/src/config.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 import path from 'path';
 import fs from 'fs/promises';
 import { pathToFileURL } from 'url';

package/src/engines/advanced.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 /**
  * AdvancedEngine
  *

package/src/engines/browser.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 /**
  * BrowserEngine
  *

package/src/engines/index.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 /**
  * Engine registry.
  *

package/src/engines/ssr.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: alter69x, akanesakuramori
+
 /**
  * SSREngine
  *

package/src/index.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 /**
  * ReviJs — Public Library API
  *

package/src/middleware.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 import path from 'path';
 import fs from 'fs/promises';
 import { isBot, detectBot } from './utils/bot-detector.js';

package/src/prerender.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 import path from 'path';
 import fs from 'fs/promises';
 import pc from 'picocolors';

package/src/setup.js

@@ -1,3 +1,14 @@
+// setup.js
+// ──────────────────────────────────────────────────────────────
+// ReviJs Browser Engine Setup Script
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+// This script ensures your system has the required browser engine
+// for ReviJs prerendering
+// ──────────────────────────────────────────────────────────────
+
 import { execSync } from 'child_process';
 import pc from 'picocolors';
 

package/src/utils/bot-detector.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 /**
  * Bot detector utility.
  *

package/src/utils/route-expander.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 /**
  * Route expander.
  *

package/src/utils/server.js

@@ -1,3 +1,8 @@
+// Copyright (c) 2026 AlphaBotz & Adarsh
+// GitHub: https://github.com/TeamAlphabotz
+// GitHub: https://github.com/utkarshdubey2008
+// Telegram: @alter69x, @akanesakuramori
+
 import http from 'http';
 import path from 'path';
 import fs from 'fs';