From b4407a204705dd400f6949db7a2914c66d03c558 Mon Sep 17 00:00:00 2001 From: Rahul Vyas Date: Sun, 22 Feb 2026 20:04:41 +0530 Subject: [PATCH 1/5] feat: update README with project details and correct logo references --- README.md | 400 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 260 insertions(+), 140 deletions(-) diff --git a/README.md b/README.md index 3c5adf2..30fe52b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@
AOSSIE - +
  @@ -12,35 +12,27 @@
-[![Static Badge](https://img.shields.io/badge/aossie.org/TODO-228B22?style=for-the-badge&labelColor=FFC517)](https://TODO.aossie.org/) - - +[![Static Badge](https://img.shields.io/badge/aossie.org/OrgExplorer-228B22?style=for-the-badge&labelColor=FFC517)](https://orgexplorer.aossie.org/)

- Telegram Badge    - -X (formerly Twitter) Badge +X Badge    - Discord Badge    - Medium Badge    - LinkedIn Badge    - Youtube Badge

@@ -48,233 +40,361 @@ ---
-

TODO: Project Name

+

OrgExplorer

-[TODO](https://TODO.stability.nexus/) is a ... TODO: Project Description. +**OrgExplorer** is an open-source intelligence platform that transforms GitHub organizations into interactive, visual ecosystems. + +Instead of browsing repositories one by one, OrgExplorer allows you to explore: + +- Relationships between repositories +- Contributor collaboration networks +- Activity trends over time +- Bus factor risks +- Language distribution +- Organizational health metrics + +It turns GitHub data into insight. --- ## πŸš€ Features -TODO: List your main features here: + **Fully Browser-Based Application** + No backend server required. Runs entirely in the browser using GitHub's REST API for data retrieval and processing. Runs entirely in the browser with no dedicated backend server. All data is fetched directly from GitHub APIs. + +- **Organization Intelligence Dashboard** + Overview of total repositories, stars, contributors, creation timeline, tech stack distribution, and activity insights. + +- **Repository Analytics** + Deep dive into repository health, commit frequency, contributor density, issue trends, and language composition. + +- **Contributor Network Visualization** + Graph-based view of how contributors collaborate across repositories. + +- **Bus Factor & Risk Insights** + Identify single points of failure and contributor concentration risks. + +- **Activity & Growth Trends** + Track repository creation patterns, commit waves, and engagement over time. + +- **REST-first Data Strategy** + Uses GitHub REST API for initial trust-building insights before enabling advanced authenticated GraphQL exploration. -- **Feature 1**: Description -- **Feature 2**: Description -- **Feature 3**: Description -- **Feature 4**: Description + **Optional Authenticated Mode** + For users who want deeper insights, an authenticated mode can be enabled to access GitHub's GraphQL API, unlocking more detailed data and analytics. --- ## πŸ’» Tech Stack -TODO: Update based on your project - ### Frontend -- React / Next.js / Flutter / React Native + - TypeScript - TailwindCSS - -### Backend -- Flask / FastAPI / Node.js / Supabase -- Database: PostgreSQL / SQLite / MongoDB - -### AI/ML (if applicable) -- LangChain / LangGraph / LlamaIndex -- Google Gemini / OpenAI / Anthropic Claude -- Vector Database: Weaviate / Pinecone / Chroma -- RAG / Prompt Engineering / Agent Frameworks - -### Blockchain (if applicable) -- Solidity / solana / cardano / ergo Smart Contracts -- Hardhat / Truffle / foundry -- Web3.js / Ethers.js / Wagmi -- OpenZeppelin / alchemy / Infura +- Framer Motion (animations) +- D3.js / Graph-based visualizations +- GitHub REST API +- Optional GraphQL API (Authenticated Mode) --- ## βœ… Project Checklist -TODO: Complete applicable items based on your project type - -- [ ] **The protocol** (if applicable): - - [ ] has been described and formally specified in a paper. - - [ ] has had its main properties mathematically proven. - - [ ] has been formally verified. -- [ ] **The smart contracts** (if applicable): - - [ ] were thoroughly reviewed by at least two knights of The Stable Order. - - [ ] were deployed to: [Add deployment details] -- [ ] **The mobile app** (if applicable): - - [ ] has an _About_ page containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus. - - [ ] is available for download as a release in this repo. - - [ ] is available in the relevant app stores. -- [ ] **The AI/ML components** (if applicable): - - [ ] LLM/model selection and configuration are documented. - - [ ] Prompts and system instructions are version-controlled. - - [ ] Content safety and moderation mechanisms are implemented. - - [ ] API keys and rate limits are properly managed. +- [x] Organization overview dashboard implemented +- [x] Repository-level analytics implemented +- [x] Contributor graph visualization system built +- [x] Advanced GraphQL authenticated mode +- [x] Enterprise-grade caching and rate optimization +- [x] Historical data tracking engine --- ## πŸ”— Repository Links -TODO: Update with your repository structure - -1. [Main Repository](https://github.com/AOSSIE-Org/TODO) -2. [Frontend](https://github.com/AOSSIE-Org/TODO/tree/main/frontend) (if separate) -3. [Backend](https://github.com/AOSSIE-Org/TODO/tree/main/backend) (if separate) +1. [Main Repository](https://github.com/AOSSIE-Org/OrgExplorer) --- ## πŸ—οΈ Architecture Diagram -TODO: Add your system architecture diagram here +```mermaid +flowchart TD +%% ========================= +%% USER BROWSER - MAIN FLOW +%% ========================= + +subgraph USER_BROWSER["User Browser"] + + %% ------------------------- + %% UI LAYER + %% ------------------------- + subgraph UI_LAYER["UI Layer"] + UI1[Organization Selector] + UI2[Repo List] + UI3[Contributor View] + UI4[Graph View] + UI5[Settings View
Add PAT / Refresh Data] + end + + %% ------------------------- + %% LOGIC LAYER + %% ------------------------- + subgraph LOGIC_LAYER["Logic Layer"] + L1[User Interaction with UI] + L2[UI State Handling
Selection Tracking] + L3[Cache Validation Logic
Check IndexedDB] + L4[Rate Limit Awareness] + end + +end + +UI1 --> L1 +UI2 --> L1 +UI3 --> L1 +UI4 --> L1 +UI5 --> L1 + +L1 --> L2 +L2 --> L3 + +%% ========================= +%% CACHE CHECK +%% ========================= + +L3 --> CACHE_DECISION{Data cached
in IndexedDB?} + +CACHE_DECISION -- Yes --> LOAD_CACHE[Load Data from IndexedDB] + +CACHE_DECISION -- No --> API_FLOW_START[Start Data Fetch
GraphQL / REST] + +%% ========================= +%% AUTH MODE DECISION +%% ========================= + +subgraph AUTH_LAYER["GitHub API Request Logic"] + + AUTH_CHECK{PAT Available?} + + AUTH_CHECK -- Yes --> AUTH_MODE[Request using PAT
Higher Rate Limit] + AUTH_CHECK -- No --> UNAUTH_MODE[Unauthenticated Mode
60 req/hour] + +end + +API_FLOW_START --> AUTH_CHECK + +AUTH_MODE --> API_REQUEST +UNAUTH_MODE --> API_REQUEST + +%% ========================= +%% GITHUB API LAYER +%% ========================= + +API_REQUEST[GitHub API Request] +API_REQUEST --> GITHUB_LAYER[GitHub API Layer
GitHub Server] + +GITHUB_LAYER --> RESPONSE_CHECK{Data Response} + +RESPONSE_CHECK -- Success --> STORE_DATA[Store in IndexedDB] +RESPONSE_CHECK -- Failure --> ERROR_STATE[Error Message
Failed to Load Data] + +STORE_DATA --> LOAD_CACHE + +%% ========================= +%% LOCAL STORAGE LAYER +%% ========================= + +subgraph LOCAL_STORAGE["Local Storage Layer"] + + subgraph INDEXED_DB["IndexedDB (via idb)"] + DB1[Org Store] + DB2[Repo Store] + DB3[Contributor Store] + DB4[Graph Store] + DB5[Node-Edge Store] + DB6[Metadata] + end + + subgraph LOCAL_STORAGE_META["localStorage"] + LS1[Last Fetched] + LS2[TTL] + LS3[GitHub Rate Info] + LS4[Known Present Flags] + end + +end + +STORE_DATA --> INDEXED_DB +STORE_DATA --> LOCAL_STORAGE_META + +LOAD_CACHE --> VISUAL_PAGE_1 +LOAD_CACHE --> VISUAL_PAGE_2 + +%% ========================= +%% VISUALIZATION PAGE 1 +%% ========================= + +subgraph VISUAL_PAGE_1["Page 1 - Repo + Contributors Graph"] + + subgraph GRAPH_LAYER_1["Visualization Layer (Graph Visualization)"] + G1_NODE[Node Builder] + G1_EDGE[Edge Builder] + G1_LAYOUT[Layout Engine] + G1_INTERACT[Interaction Layer
Hover β†’ Tooltip
Click β†’ Detail Panel] + end + + G1_NOTE[Shows one repo with all contributors
Node & Edge Form] + +end + +%% ========================= +%% VISUALIZATION PAGE 2 +%% ========================= + +subgraph VISUAL_PAGE_2["Page 2 - All Repos Graph"] + + subgraph GRAPH_LAYER_2["Visualization Layer (Graph Visualization)"] + G2_NODE[Node Builder] + G2_EDGE[Edge Builder] + G2_LAYOUT[Layout Engine] + G2_INTERACT[Interaction Layer
Hover β†’ Tooltip
Click β†’ Detail Panel] + end + + G2_NOTE[Shows all repos
Node & Edge Form] + +end ``` -[Architecture Diagram Placeholder] -``` -You can create architecture diagrams using: -- [Draw.io](https://draw.io) -- [Excalidraw](https://excalidraw.com) -- [Lucidchart](https://lucidchart.com) -- [Mermaid](https://mermaid.js.org) (for code-based diagrams) +### System Structure + +- Frontend (React + D3.js) +- Data Processing Layer (analytics engine) +- GitHub REST API +- Optional GitHub GraphQL API +- Database (IndexedDB for caching, local storage for user settings) +- UI Rendering Layer (dashboard, graphs, panels) + +Data flows: -Example structure to include: -- Frontend components -- Backend services -- Database architecture -- External APIs/services -- Data flow between components +User β†’ Frontend β†’ API β†’ GitHub APIs β†’ Processing Layer β†’ Database β†’ UI Rendering --- ## πŸ”„ User Flow -TODO: Add user flow diagrams showing how users interact with your application - ``` -[User Flow Diagram Placeholder] +User enters organization name + ↓ +REST API fetches public insights + ↓ +Analytics engine computes metrics + ↓ +Dashboard renders visual intelligence + ↓ +(Optional) User enables advanced authenticated mode ``` ### Key User Journeys -TODO: Document main user flows: - -1. **User Journey 1**: Description - - Step 1 - - Step 2 - - Step 3 +1. **Explore an Organization** + - Enter org name + - View overview dashboard + - Analyze repository metrics -2. **User Journey 2**: Description - - Step 1 - - Step 2 - - Step 3 +2. **Analyze Contributor Network** + - Open contributor graph + - Inspect collaboration edges + - Identify central contributors -3. **User Journey 3**: Description - - Step 1 - - Step 2 - - Step 3 +3. **Risk Assessment** + - Open bus factor panel + - Detect low contributor redundancy + - Review critical repositories --- -## οΏ½πŸ€ Getting Started +## πŸ€ Getting Started ### Prerequisites -TODO: List what developers need installed +- Node.js 18+ +- npm / pnpm / yarn +- GitHub API rate awareness -- Node.js 18+ / Python 3.9+ / Flutter SDK -- npm / yarn / pnpm -- [Any specific tools or accounts needed] +--- ### Installation -TODO: Provide detailed setup instructions - #### 1. Clone the Repository ```bash -git clone https://github.com/AOSSIE-Org/TODO.git -cd TODO +git clone https://github.com/AOSSIE-Org/OrgExplorer.git +cd OrgExplorer ``` #### 2. Install Dependencies ```bash npm install -# or -yarn install -# or -pnpm install -``` - -#### 3. Configure Environment Variables(.env.example) - -Create a `.env` file in the root directory: - -```env -# Add your environment variables here -API_KEY=your_api_key -DATABASE_URL=your_database_url ``` -#### 4. Run the Development Server +#### 3. Run Development Server ```bash npm run dev -# or -yarn dev -# or -pnpm dev ``` -#### 5. Open your Browser +#### 4. Open Browser -Navigate to [http://localhost:3000](http://localhost:3000) to see the application. +Navigate to: -For detailed setup instructions, please refer to our [Installation Guide](./docs/INSTALL_GUIDE.md) (if you have one). +http://localhost:3000 --- -## πŸ“± App Screenshots -TODO: Add screenshots showcasing your application +## πŸ™Œ Contributing -| | | | -|---|---|---| -| Screenshot 1 | Screenshot 2 | Screenshot 3 | +We welcome developers, designers, data scientists, and open-source enthusiasts. ---- +Ways you can contribute: -## πŸ™Œ Contributing +- Improve analytics algorithms +- Enhance UI/UX +- Optimize API rate handling +- Add new visualizations +- Improve documentation +- Fix bugs & performance issues -⭐ Don't forget to star this repository if you find it useful! ⭐ +Before contributing: -Thank you for considering contributing to this project! Contributions are highly appreciated and welcomed. To ensure smooth collaboration, please refer to our [Contribution Guidelines](./CONTRIBUTING.md). +1. Fork the repository +2. Create a feature branch +3. Follow coding standards +4. Submit a pull request with clear description + +Please read our [Contribution Guidelines](./CONTRIBUTING.md). + +If you love the vision β€” give it a ⭐. --- ## ✨ Maintainers -TODO: Add maintainer information - -- [Maintainer Name](https://github.com/username) -- [Maintainer Name](https://github.com/username) +- AOSSIE Core Team --- ## πŸ“ License -This project is licensed under the GNU General Public License v3.0. +This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details. --- ## πŸ’ͺ Thanks To All Contributors -Thanks a lot for spending your time helping TODO grow. Keep rocking πŸ₯‚ - -[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/TODO)](https://github.com/AOSSIE-Org/TODO/graphs/contributors) +Open source grows because of people like you. -Β© 2025 AOSSIE +Β© 2026 AOSSIE. All rights reserved. \ No newline at end of file From d1b99e9eab22749aed5d0db2efbf28ff09acceb4 Mon Sep 17 00:00:00 2001 From: Rahul Vyas Date: Tue, 9 Jun 2026 12:53:06 +0530 Subject: [PATCH 2/5] feat/README and CONTRIBUTING work --- CONTRIBUTING.md | 52 +++++++++++++++++++++ README.md | 118 ++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 166 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 286b79e..57db1fe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,12 +50,24 @@ Before opening an issue, search existing ones to avoid duplicates. Useful bug re OrgExplorer is a **single-package frontend** application: +<<<<<<< HEAD | Area | Stack | |------|--------| | UI | [React](https://react.dev/) 19 | | Language | [TypeScript](https://www.typescriptlang.org/) | | Build & dev server | [Vite](https://vite.dev/) (with `@vitejs/plugin-react`) | | Linting | [ESLint](https://eslint.org/) 9 (flat config in `eslint.config.js`) | +======= +| Component | Technology | +|-----------|-----------| +| **UI Framework** | React 18 with JavaScript | +| **Styling** | TailwindCSS | +| **Build Tool** | Vite | +| **Linting** | ESLint 9 | +| **Data Fetching** | GitHub REST & GraphQL APIs | +| **Visualizations** | D3.js & Recharts | +| **Storage** | IndexedDB (browser-based) | +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) Approximate layout: @@ -63,6 +75,7 @@ Approximate layout: OrgExplorer/ β”œβ”€β”€ public/ # Static assets (e.g. logos) β”œβ”€β”€ src/ +<<<<<<< HEAD β”‚ β”œβ”€β”€ App.tsx # Root UI β”‚ β”œβ”€β”€ main.tsx # React entry β”‚ └── *.css # Styles @@ -71,11 +84,30 @@ OrgExplorer/ β”œβ”€β”€ eslint.config.js β”œβ”€β”€ tsconfig.json # TypeScript project references └── package.json +======= +β”‚ β”œβ”€β”€ App.jsx # Root component +β”‚ β”œβ”€β”€ main.jsx # React entry point +β”‚ β”œβ”€β”€ components/ # Reusable components +β”‚ β”œβ”€β”€ pages/ # Page components +β”‚ β”œβ”€β”€ context/ # Context providers +β”‚ β”œβ”€β”€ hooks/ # Custom hooks +β”‚ β”œβ”€β”€ services/ # API clients and utility functions +β”‚ └── styles/ # Global & module styles +β”œβ”€β”€ index.html # HTML entry point +β”œβ”€β”€ vite.config.js # Vite configuration +β”œβ”€β”€ eslint.config.js # ESLint rules +β”œβ”€β”€ tsconfig.json # TypeScript config +└── package.json # Dependencies & scripts +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ``` There is **no `test` script** in `package.json` yet. Before opening a PR, run **lint** and **build** locally (see below). +<<<<<<< HEAD ## Getting started +======= +## Getting Started +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ### Prerequisites @@ -229,10 +261,14 @@ Brief summary of changes. ## Related issue Fixes #23 +<<<<<<< HEAD ## Testing - `npm run lint` - `npm run build` - Manual: … +======= +### JavaScript & React +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ## Checklist See PR template. @@ -240,6 +276,7 @@ See PR template. ## Code style +<<<<<<< HEAD ### TypeScript and React - Follow the existing **ESLint** setup in `eslint.config.js` (`typescript-eslint`, React Hooks, React Refresh for Vite). @@ -248,6 +285,11 @@ See PR template. - Match formatting and patterns in nearby files. ### General +======= +- **No unnecessary dependencies** β€” Use browser APIs when possible +- **No secrets or large artifacts** β€” Don't commit API keys, build outputs, or node_modules +- **Keep it simple** β€” Avoid over-engineering; favor readability +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) - Avoid unnecessary dependencies. - Do not commit secrets or large generated artifacts unrelated to the feature. @@ -265,4 +307,14 @@ See PR template. --- +<<<<<<< HEAD Thank you for helping improve OrgExplorer. +======= +## Questions? + +- πŸ’¬ **Discord**: Ask on [AOSSIE server](https://discord.gg/hjUhu33uAn) +- πŸ› **Bug reports**: Open an [issue](https://github.com/AOSSIE-Org/OrgExplorer/issues) +- πŸ’‘ **Ideas**: Start a [discussion](https://github.com/AOSSIE-Org/OrgExplorer/discussions) + +Thank you for contributing to OrgExplorer! πŸŽ‰ +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) diff --git a/README.md b/README.md index 30fe52b..4fe06aa 100644 --- a/README.md +++ b/README.md @@ -3,16 +3,36 @@
+ AOSSIE -
+<<<<<<< HEAD  
[![Static Badge](https://img.shields.io/badge/aossie.org/OrgExplorer-228B22?style=for-the-badge&labelColor=FFC517)](https://orgexplorer.aossie.org/) +======= +
+ + + +X Badge +   + +Discord Badge +   + + LinkedIn Badge +   + + Youtube Badge +    + +[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE) +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work)
@@ -39,6 +59,7 @@ --- +<<<<<<< HEAD

OrgExplorer

@@ -55,11 +76,26 @@ Instead of browsing repositories one by one, OrgExplorer allows you to explore: - Organizational health metrics It turns GitHub data into insight. +======= +**OrgExplorer** transforms GitHub organizations into interactive, visual intelligence dashboards. Explore repository relationships, compare two or more organizations, contributor networks, activity trends, risk metrics, and organizational healthβ€”all without leaving your browser. + +### Key Insights + +- Organizational structure and repository relationships +- Comparative analysis of multiple organizations +- Repository relationship mapping +- Contributor collaboration networks +- Activity trends and growth patterns +- Bus factor & single-point-of-failure detection +- Technology stack distribution +- Real-time organizational metrics +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) --- ## πŸš€ Features +<<<<<<< HEAD **Fully Browser-Based Application** No backend server required. Runs entirely in the browser using GitHub's REST API for data retrieval and processing. Runs entirely in the browser with no dedicated backend server. All data is fetched directly from GitHub APIs. @@ -83,11 +119,35 @@ It turns GitHub data into insight. **Optional Authenticated Mode** For users who want deeper insights, an authenticated mode can be enabled to access GitHub's GraphQL API, unlocking more detailed data and analytics. +======= +- **Fully Browser-Based** β€” Runs entirely in the browser using GitHub APIs with no backend server required. + +- **Organization Overview Dashboard** β€” Explore repositories, contributors, activity trends, tech stack distribution, and organization growth insights. + +- **Advanced Repository Analytics** β€” Analyze repository activity, contributor density, issue and PR trends, health metrics, and lifecycle status. + +- **Contributor & Repository Network Graphs** β€” Interactive visualizations for contributor collaboration and repository-centric contributor relationships. + +- **Multi-Organization Analysis** β€” Compare and analyze multiple GitHub organizations together. + +- **Repository Health & Governance Insights** β€” Detect inactive repositories, stale issues/PRs, missing licenses, and contributor concentration risks. + +- **Time-Series Activity Charts** β€” Visualize weekly and monthly repository, issue, and pull request activity trends. + +- **Persistent API Cache & Performance Optimization** β€” IndexedDB-powered caching and optimized handling for large organizations and datasets. + +- **Personal Access Token (PAT) & API Quota Support** β€” Optional authenticated mode with rate limit awareness and enhanced API access. + +- **Advanced Repository Explorer** β€” Interactive repository table with filtering, sorting, and computed analytics metrics. + +- **Export & Share Features** β€” Export analytics reports and share application state through URL-based deep linking. +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) --- ## πŸ’» Tech Stack +<<<<<<< HEAD ### Frontend - TypeScript @@ -96,6 +156,13 @@ It turns GitHub data into insight. - D3.js / Graph-based visualizations - GitHub REST API - Optional GraphQL API (Authenticated Mode) +======= +**Frontend**: React 18 Β· JavaScript Β· TailwindCSS Β· Vite +**Visualizations**: D3.js Β· Recharts +**Data**: GitHub REST & GraphQL APIs +**Storage**: IndexedDB (browser-based caching), Local Storage (user settings) +**Build**: Vite with React plugin +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) --- @@ -268,7 +335,7 @@ end ### System Structure -- Frontend (React + D3.js) +- Frontend (React + D3.js + Recharts) - Data Processing Layer (analytics engine) - GitHub REST API - Optional GitHub GraphQL API @@ -286,7 +353,7 @@ User β†’ Frontend β†’ API β†’ GitHub APIs β†’ Processing Layer β†’ Database β†’ ``` User enters organization name ↓ -REST API fetches public insights +REST API fetches public insights for organization ↓ Analytics engine computes metrics ↓ @@ -297,6 +364,7 @@ Dashboard renders visual intelligence ### Key User Journeys +<<<<<<< HEAD 1. **Explore an Organization** - Enter org name - View overview dashboard @@ -306,6 +374,23 @@ Dashboard renders visual intelligence - Open contributor graph - Inspect collaboration edges - Identify central contributors +======= +1. **Clone & Install** + + ```bash + git clone https://github.com/AOSSIE-Org/OrgExplorer.git + cd OrgExplorer + npm install + ``` + +2. **Run Development Server** + + ```bash + npm run dev + ``` + + Open http://localhost:5173 in your browser. +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) 3. **Risk Assessment** - Open bus factor panel @@ -316,6 +401,7 @@ Dashboard renders visual intelligence ## πŸ€ Getting Started +<<<<<<< HEAD ### Prerequisites - Node.js 18+ @@ -386,6 +472,15 @@ If you love the vision β€” give it a ⭐. --- +======= +We welcome contributions from developers, designers, and open-source enthusiasts. See [CONTRIBUTING.md](./CONTRIBUTING.md) for: + +- How to report bugs and suggest features +- Development workflow and coding standards +- Pull request guidelines +- Community communication + +>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ## πŸ“ License This project is licensed under the GNU General Public License v3.0. @@ -397,4 +492,19 @@ See the [LICENSE](LICENSE) file for details. Open source grows because of people like you. -Β© 2026 AOSSIE. All rights reserved. \ No newline at end of file +<<<<<<< HEAD +Β© 2026 AOSSIE. All rights reserved. +======= +Β© 2026 AOSSIE. All rights reserved. + +--- + +## πŸ’ͺThanks To All Contributors + +Thanks a lot for spending your time helping Resonate grow. Keep rocking πŸ₯‚ + + + Contributors + +
+>>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) From 0db7d25b65bec932c99c9a2b25edac9e447badab Mon Sep 17 00:00:00 2001 From: Rahul Vyas Date: Tue, 9 Jun 2026 13:47:57 +0530 Subject: [PATCH 3/5] fix conflict --- CONTRIBUTING.md | 46 ------------- README.md | 175 ------------------------------------------------ 2 files changed, 221 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57db1fe..dd92f70 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,14 +50,6 @@ Before opening an issue, search existing ones to avoid duplicates. Useful bug re OrgExplorer is a **single-package frontend** application: -<<<<<<< HEAD -| Area | Stack | -|------|--------| -| UI | [React](https://react.dev/) 19 | -| Language | [TypeScript](https://www.typescriptlang.org/) | -| Build & dev server | [Vite](https://vite.dev/) (with `@vitejs/plugin-react`) | -| Linting | [ESLint](https://eslint.org/) 9 (flat config in `eslint.config.js`) | -======= | Component | Technology | |-----------|-----------| | **UI Framework** | React 18 with JavaScript | @@ -67,7 +59,6 @@ OrgExplorer is a **single-package frontend** application: | **Data Fetching** | GitHub REST & GraphQL APIs | | **Visualizations** | D3.js & Recharts | | **Storage** | IndexedDB (browser-based) | ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) Approximate layout: @@ -75,16 +66,6 @@ Approximate layout: OrgExplorer/ β”œβ”€β”€ public/ # Static assets (e.g. logos) β”œβ”€β”€ src/ -<<<<<<< HEAD -β”‚ β”œβ”€β”€ App.tsx # Root UI -β”‚ β”œβ”€β”€ main.tsx # React entry -β”‚ └── *.css # Styles -β”œβ”€β”€ index.html -β”œβ”€β”€ vite.config.ts -β”œβ”€β”€ eslint.config.js -β”œβ”€β”€ tsconfig.json # TypeScript project references -└── package.json -======= β”‚ β”œβ”€β”€ App.jsx # Root component β”‚ β”œβ”€β”€ main.jsx # React entry point β”‚ β”œβ”€β”€ components/ # Reusable components @@ -98,16 +79,11 @@ OrgExplorer/ β”œβ”€β”€ eslint.config.js # ESLint rules β”œβ”€β”€ tsconfig.json # TypeScript config └── package.json # Dependencies & scripts ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ``` There is **no `test` script** in `package.json` yet. Before opening a PR, run **lint** and **build** locally (see below). -<<<<<<< HEAD -## Getting started -======= ## Getting Started ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ### Prerequisites @@ -261,14 +237,7 @@ Brief summary of changes. ## Related issue Fixes #23 -<<<<<<< HEAD -## Testing -- `npm run lint` -- `npm run build` -- Manual: … -======= ### JavaScript & React ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ## Checklist See PR template. @@ -276,20 +245,9 @@ See PR template. ## Code style -<<<<<<< HEAD -### TypeScript and React - -- Follow the existing **ESLint** setup in `eslint.config.js` (`typescript-eslint`, React Hooks, React Refresh for Vite). -- Prefer `const`; use `let` only when reassignment is needed. -- Use meaningful names; keep components and functions focused. -- Match formatting and patterns in nearby files. - -### General -======= - **No unnecessary dependencies** β€” Use browser APIs when possible - **No secrets or large artifacts** β€” Don't commit API keys, build outputs, or node_modules - **Keep it simple** β€” Avoid over-engineering; favor readability ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) - Avoid unnecessary dependencies. - Do not commit secrets or large generated artifacts unrelated to the feature. @@ -307,9 +265,6 @@ See PR template. --- -<<<<<<< HEAD -Thank you for helping improve OrgExplorer. -======= ## Questions? - πŸ’¬ **Discord**: Ask on [AOSSIE server](https://discord.gg/hjUhu33uAn) @@ -317,4 +272,3 @@ Thank you for helping improve OrgExplorer. - πŸ’‘ **Ideas**: Start a [discussion](https://github.com/AOSSIE-Org/OrgExplorer/discussions) Thank you for contributing to OrgExplorer! πŸŽ‰ ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) diff --git a/README.md b/README.md index 4fe06aa..480c409 100644 --- a/README.md +++ b/README.md @@ -7,14 +7,6 @@ AOSSIE
-<<<<<<< HEAD -  - - -
- -[![Static Badge](https://img.shields.io/badge/aossie.org/OrgExplorer-228B22?style=for-the-badge&labelColor=FFC517)](https://orgexplorer.aossie.org/) -=======
@@ -32,51 +24,11 @@    [![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE) ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work)
- -

- -Telegram Badge -   - -X Badge -   - -Discord Badge -   - - Medium Badge -   - - LinkedIn Badge -   - - Youtube Badge -

- --- -<<<<<<< HEAD -
-

OrgExplorer

-
- -**OrgExplorer** is an open-source intelligence platform that transforms GitHub organizations into interactive, visual ecosystems. - -Instead of browsing repositories one by one, OrgExplorer allows you to explore: - -- Relationships between repositories -- Contributor collaboration networks -- Activity trends over time -- Bus factor risks -- Language distribution -- Organizational health metrics - -It turns GitHub data into insight. -======= **OrgExplorer** transforms GitHub organizations into interactive, visual intelligence dashboards. Explore repository relationships, compare two or more organizations, contributor networks, activity trends, risk metrics, and organizational healthβ€”all without leaving your browser. ### Key Insights @@ -89,37 +41,11 @@ It turns GitHub data into insight. - Bus factor & single-point-of-failure detection - Technology stack distribution - Real-time organizational metrics ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) --- ## πŸš€ Features -<<<<<<< HEAD - **Fully Browser-Based Application** - No backend server required. Runs entirely in the browser using GitHub's REST API for data retrieval and processing. Runs entirely in the browser with no dedicated backend server. All data is fetched directly from GitHub APIs. - -- **Organization Intelligence Dashboard** - Overview of total repositories, stars, contributors, creation timeline, tech stack distribution, and activity insights. - -- **Repository Analytics** - Deep dive into repository health, commit frequency, contributor density, issue trends, and language composition. - -- **Contributor Network Visualization** - Graph-based view of how contributors collaborate across repositories. - -- **Bus Factor & Risk Insights** - Identify single points of failure and contributor concentration risks. - -- **Activity & Growth Trends** - Track repository creation patterns, commit waves, and engagement over time. - -- **REST-first Data Strategy** - Uses GitHub REST API for initial trust-building insights before enabling advanced authenticated GraphQL exploration. - - **Optional Authenticated Mode** - For users who want deeper insights, an authenticated mode can be enabled to access GitHub's GraphQL API, unlocking more detailed data and analytics. -======= - **Fully Browser-Based** β€” Runs entirely in the browser using GitHub APIs with no backend server required. - **Organization Overview Dashboard** β€” Explore repositories, contributors, activity trends, tech stack distribution, and organization growth insights. @@ -141,28 +67,16 @@ It turns GitHub data into insight. - **Advanced Repository Explorer** β€” Interactive repository table with filtering, sorting, and computed analytics metrics. - **Export & Share Features** β€” Export analytics reports and share application state through URL-based deep linking. ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) --- ## πŸ’» Tech Stack -<<<<<<< HEAD -### Frontend - -- TypeScript -- TailwindCSS -- Framer Motion (animations) -- D3.js / Graph-based visualizations -- GitHub REST API -- Optional GraphQL API (Authenticated Mode) -======= **Frontend**: React 18 Β· JavaScript Β· TailwindCSS Β· Vite **Visualizations**: D3.js Β· Recharts **Data**: GitHub REST & GraphQL APIs **Storage**: IndexedDB (browser-based caching), Local Storage (user settings) **Build**: Vite with React plugin ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) --- @@ -364,17 +278,6 @@ Dashboard renders visual intelligence ### Key User Journeys -<<<<<<< HEAD -1. **Explore an Organization** - - Enter org name - - View overview dashboard - - Analyze repository metrics - -2. **Analyze Contributor Network** - - Open contributor graph - - Inspect collaboration edges - - Identify central contributors -======= 1. **Clone & Install** ```bash @@ -390,7 +293,6 @@ Dashboard renders visual intelligence ``` Open http://localhost:5173 in your browser. ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) 3. **Risk Assessment** - Open bus factor panel @@ -401,78 +303,6 @@ Dashboard renders visual intelligence ## πŸ€ Getting Started -<<<<<<< HEAD -### Prerequisites - -- Node.js 18+ -- npm / pnpm / yarn -- GitHub API rate awareness - ---- - -### Installation - -#### 1. Clone the Repository - -```bash -git clone https://github.com/AOSSIE-Org/OrgExplorer.git -cd OrgExplorer -``` - -#### 2. Install Dependencies - -```bash -npm install -``` - -#### 3. Run Development Server - -```bash -npm run dev -``` - -#### 4. Open Browser - -Navigate to: - -http://localhost:3000 - ---- - - -## πŸ™Œ Contributing - -We welcome developers, designers, data scientists, and open-source enthusiasts. - -Ways you can contribute: - -- Improve analytics algorithms -- Enhance UI/UX -- Optimize API rate handling -- Add new visualizations -- Improve documentation -- Fix bugs & performance issues - -Before contributing: - -1. Fork the repository -2. Create a feature branch -3. Follow coding standards -4. Submit a pull request with clear description - -Please read our [Contribution Guidelines](./CONTRIBUTING.md). - -If you love the vision β€” give it a ⭐. - ---- - -## ✨ Maintainers - -- AOSSIE Core Team - ---- - -======= We welcome contributions from developers, designers, and open-source enthusiasts. See [CONTRIBUTING.md](./CONTRIBUTING.md) for: - How to report bugs and suggest features @@ -480,7 +310,6 @@ We welcome contributions from developers, designers, and open-source enthusiasts - Pull request guidelines - Community communication ->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) ## πŸ“ License This project is licensed under the GNU General Public License v3.0. @@ -492,9 +321,6 @@ See the [LICENSE](LICENSE) file for details. Open source grows because of people like you. -<<<<<<< HEAD -Β© 2026 AOSSIE. All rights reserved. -======= Β© 2026 AOSSIE. All rights reserved. --- @@ -507,4 +333,3 @@ Thanks a lot for spending your time helping Resonate grow. Keep rocking πŸ₯‚ Contributors
->>>>>>> 29b1eb4 (feat/README and CONTRIBUTING work) From da8f65414530359bb1fd98e31c93de9f1598ac0a Mon Sep 17 00:00:00 2001 From: Rahul Vyas Date: Tue, 9 Jun 2026 13:54:32 +0530 Subject: [PATCH 4/5] chore: remove deplicate 'Thanks To All Contributors' section from README --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 480c409..cc38206 100644 --- a/README.md +++ b/README.md @@ -325,8 +325,6 @@ Open source grows because of people like you. --- -## πŸ’ͺThanks To All Contributors - Thanks a lot for spending your time helping Resonate grow. Keep rocking πŸ₯‚ From cf8f5e6ce649b189dbe4edd16e71e8fc43d4a77d Mon Sep 17 00:00:00 2001 From: Rahul Vyas Date: Wed, 10 Jun 2026 18:19:01 +0530 Subject: [PATCH 5/5] fix: update project name in gratitude message in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc38206..7cb9cea 100644 --- a/README.md +++ b/README.md @@ -325,7 +325,7 @@ Open source grows because of people like you. --- -Thanks a lot for spending your time helping Resonate grow. Keep rocking πŸ₯‚ +Thanks a lot for spending your time helping OrgExplorer grow. Keep rocking πŸ₯‚ Contributors