Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions .github/badges.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
badges:
- name: Build Status
image: https://img.shields.io/github/actions/workflow/status/{owner}/{repo}/ci.yml?label=Build&style=flat-square
url: https://github.com/{owner}/{repo}/actions/workflows/ci.yml
- name: License
image: https://img.shields.io/badge/License-CC%20BY--NC%204.0-blue.svg?style=flat-square
url: LICENSE
- name: GitHub Stars
image: https://img.shields.io/github/stars/{owner}/{repo}?style=flat-square
url: https://github.com/{owner}/{repo}
- name: 'License'
shield: 'https://img.shields.io/badge/license-CC%20BY--NC%204.0-blue.svg'
url: 'https://creativecommons.org/licenses/by-nc/4.0/'
- name: 'Vite'
shield: 'https://img.shields.io/badge/vite-^7.2.4-blue.svg'
url: 'https://vitejs.dev/'
- name: 'TypeScript'
shield: 'https://img.shields.io/badge/typescript-^6.0.0--beta-blue.svg'
url: 'https://www.typescriptlang.org/'
- name: 'Tailwind CSS'
shield: 'https://img.shields.io/badge/tailwind%20css-^4.1.18-blue.svg'
url: 'https://tailwindcss.com/'
- name: 'React'
shield: 'https://img.shields.io/badge/react-^19.2.3-blue.svg'
url: 'https://reactjs.org/'
- name: 'Biome'
shield: 'https://img.shields.io/badge/biome-^1.8.3-blue.svg'
url: 'https://biomejs.dev/'
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ jobs:
node-version: '20.x'
cache: 'npm'
- run: npm install
- run: npm run format
- run: npm run lint
- run: npm run build --if-present
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ We welcome contributions to AlgoLens! Please follow these guidelines to ensure t
* `npm run dev`: Starts the development server.
* `npm run build`: Builds the application for production.
* `npm run lint`: Lints the code.
* `npm run test`: Runs the tests.
* `npm run format`: Formats the code.

## Pull Requests
* Please ensure that your code is linted and that all tests pass before submitting a pull request.
* Please ensure that your code is formatted and linted before submitting a pull request.
* Please provide a clear and concise description of the changes in your pull request.
* Please link to any relevant issues in your pull request.
93 changes: 63 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,88 @@
# AlgoLens: A Frontend for Search Ranking Customization

[![Build Status](https://img.shields.io/github/actions/workflow/status/chirag127/AlgoLens-Search-Ranking-Configuration-Guide/ci.yml?style=flat-square)](https://github.com/chirag127/AlgoLens-Search-Ranking-Configuration-Guide/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/License-CC%20BY--NC%204.0-blue.svg?style=flat-square)](LICENSE)
[![GitHub Stars](https://img.shields.io/github/stars/chirag127/AlgoLens-Search-Ranking-Configuration-Guide?style=flat-square)](https://github.com/chirag127/AlgoLens-Search-Ranking-Configuration-Guide)

**Star ⭐ this Repo if you find it valuable!**

---
<!-- BADGES START -->
<!-- This section will be automatically updated by a GitHub Action -->
<p align="center">
<a href="https://creativecommons.org/licenses/by-nc/4.0/">
<img src="https://img.shields.io/badge/license-CC%20BY--NC%204.0-blue.svg" alt="License">
</a>
<a href="https://vitejs.dev/">
<img src="https://img.shields.io/badge/vite-^7.2.4-blue.svg" alt="Vite">
</a>
<a href="https://www.typescriptlang.org/">
<img src="https://img.shields.io/badge/typescript-^6.0.0--beta-blue.svg" alt="TypeScript">
</a>
<a href="https://tailwindcss.com/">
<img src="https://img.shields.io/badge/tailwind%20css-^4.1.18-blue.svg" alt="Tailwind CSS">
</a>
<a href="https://reactjs.org/">
<img src="https://img.shields.io/badge/react-^19.2.3-blue.svg" alt="React">
</a>
<a href="https://biomejs.dev/">
<img src="https://img.shields.io/badge/biome-^1.8.3-blue.svg" alt="Biome">
</a>
</p>
<!-- BADGES END -->

## 🚀 Project Overview

AlgoLens is a modern, frontend-only application for viewing and managing Brave Goggles. It provides a clean, "Spatial-Adaptive" interface for browsing and inspecting `.goggle` files, which are custom search ranking configurations for the Brave Search ecosystem.
AlgoLens is a modern, **frontend-only** application for viewing and managing Brave Goggles. It provides a clean, "Spatial Glass" and "Bento Grid" inspired interface for browsing and inspecting `.goggle` files, which are custom search ranking configurations for the Brave Search ecosystem.

This project is built with a cutting-edge tech stack and adheres to the Dec 2025 standards for frontend development, ensuring a high-velocity, zero-defect, and future-proof codebase.

This project is built with Vite, TypeScript, and Tailwind CSS, and it is designed to be deployed to static hosting platforms like GitHub Pages, Vercel, or Netlify.
## 🏛️ Architecture

## 🎯 Core Objective
AlgoLens follows a strict frontend-only architecture, running entirely in the browser. It leverages direct REST API calls to various AI providers, with users providing their own API keys at runtime.

The primary goal of AlgoLens is to provide a user-friendly interface for interacting with Brave Goggles. It aims to be a lightweight and performant tool for developers and power users who want to customize their search experience.
```
+---------------------------------+
| Browser (UI) |
| (React, Tailwind, Signals) |
+---------------------------------+
|
| (User-provided API Keys)
v
+---------------------------------+
| API Service Layer |
| (Cerebras, Gemini, Groq, etc.) |
+---------------------------------+
```

## ⚙️ Development Standards
## 🛠️ Tech Stack

### Prerequisites
* Node.js (v20.x LTS or newer)
* npm
- **Framework:** [Vite](https://vitejs.dev/) ^7.2.4
- **Language:** [TypeScript](https://www.typescriptlang.org/) ^6.0.0-beta
- **UI:** [React](https://reactjs.org/) ^19.2.3, [Tailwind CSS](https://tailwindcss.com/) ^4.1.18
- **State Management:** [@preact/signals-react](https://preactjs.com/guide/v10/signals/)
- **Linting/Formatting:** [Biome](https://biomejs.dev/) ^1.8.3

### Setup & Installation
## ⚡ Quickstart

1. **Clone Repository:**
```bash
1. **Clone the repository:**
```sh
git clone https://github.com/chirag127/AlgoLens-Search-Ranking-Configuration-Guide.git
cd AlgoLens-Search-Ranking-Configuration-Guide
```

2. **Install Dependencies:**
```bash
2. **Install dependencies:**
```sh
npm install
```
3. **Run the development server:**
```sh
npm run dev
```

### Core Scripts

| Script | Description |
| :--- | :--- |
| `npm run dev` | Starts the local development server. |
| `npm run build` | Builds the application for production. |
| `npm run lint` | Lints the code. |
## ✨ Features

- **Goggle Viewer:** Browse and inspect `.goggle` files.
- **AI Integration:** Leverage multiple AI providers for advanced features (coming soon).
- **Modern UI:** A sleek, "Spatial Glass" and "Bento Grid" inspired interface.
- **Frontend-Only:** Runs entirely in the browser with no backend dependencies.

## 🤝 Contributing

Contributions are welcomed! Please review the detailed guidelines in [CONTRIBUTING.md](./CONTRIBUTING.md) before submitting pull requests.
Contributions are welcome! Please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file for details on how to get started.

## 📄 License

This project is licensed under the **Creative Commons Attribution-NonCommercial 4.0 International License**. See the [LICENSE](./LICENSE) file for details.
This project is licensed under the [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) license.
File renamed without changes.
16 changes: 16 additions & 0 deletions biome.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
"organizeImports": {
"enabled": true
},
"linter": {
"enabled": true,
"rules": {
"recommended": true
}
},
"formatter": {
"enabled": true,
"indentStyle": "space"
}
}
Loading
Loading