From 4e6fa995fa93ffc2bce2a02b453999132de141d0 Mon Sep 17 00:00:00 2001 From: yanamavani Date: Wed, 11 Mar 2026 22:54:53 +0530 Subject: [PATCH 1/7] Improve README --- README.md | 51 +++++++++++++++++++++++++-------------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 3c5adf2..412c43c 100644 --- a/README.md +++ b/README.md @@ -48,27 +48,26 @@ ---
-

TODO: Project Name

+

OrgExplorer

-[TODO](https://TODO.stability.nexus/) is a ... TODO: Project Description. - +OrgExplorer is a web application that allows users to explore GitHub organizations, +their repositories, and contributor insights. It provides an interactive way to +visualize repository statistics such as stars, forks, and contributors. --- ## 🚀 Features -TODO: List your main features here: - -- **Feature 1**: Description -- **Feature 2**: Description -- **Feature 3**: Description -- **Feature 4**: Description +- Explore repositories of a GitHub organization +- View repository statistics (stars, forks, issues) +- Analyze contributor activity +- Interactive charts and insights for repositories --- ## 💻 Tech Stack -TODO: Update based on your project +OrgExplorer: Update based on your project ### Frontend - React / Next.js / Flutter / React Native @@ -95,7 +94,7 @@ TODO: Update based on your project ## ✅ Project Checklist -TODO: Complete applicable items based on your project type +OrgExplorer: Complete applicable items based on your project type - [ ] **The protocol** (if applicable): - [ ] has been described and formally specified in a paper. @@ -118,17 +117,17 @@ TODO: Complete applicable items based on your project type ## 🔗 Repository Links -TODO: Update with your repository structure +OrgExplorer: 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) +2. [Frontend](https://github.com/AOSSIE-Org/OrgExplorer/tree/main/frontend) (if separate) +3. [Backend](https://github.com/AOSSIE-Org/OrgExplorer/tree/main/backend) (if separate) --- ## 🏗️ Architecture Diagram -TODO: Add your system architecture diagram here +OrgExplorer: Add your system architecture diagram here ``` [Architecture Diagram Placeholder] @@ -151,7 +150,7 @@ Example structure to include: ## 🔄 User Flow -TODO: Add user flow diagrams showing how users interact with your application +OrgExplorer: Add user flow diagrams showing how users interact with your application ``` [User Flow Diagram Placeholder] @@ -159,7 +158,7 @@ TODO: Add user flow diagrams showing how users interact with your application ### Key User Journeys -TODO: Document main user flows: +OrgExplorer: Document main user flows: 1. **User Journey 1**: Description - Step 1 @@ -182,7 +181,7 @@ TODO: Document main user flows: ### Prerequisites -TODO: List what developers need installed +OrgExplorer: List what developers need installed - Node.js 18+ / Python 3.9+ / Flutter SDK - npm / yarn / pnpm @@ -190,13 +189,13 @@ TODO: List what developers need installed ### Installation -TODO: Provide detailed setup instructions +OrgExplorer: 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 @@ -239,7 +238,7 @@ For detailed setup instructions, please refer to our [Installation Guide](./docs ## 📱 App Screenshots -TODO: Add screenshots showcasing your application +OrgExplorer: Add screenshots showcasing your application | | | | |---|---|---| @@ -257,7 +256,7 @@ Thank you for considering contributing to this project! Contributions are highly ## ✨ Maintainers -TODO: Add maintainer information +OrgExplorer: Add maintainer information - [Maintainer Name](https://github.com/username) - [Maintainer Name](https://github.com/username) @@ -273,8 +272,8 @@ See the [LICENSE](LICENSE) file for details. ## 💪 Thanks To All Contributors -Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂 +Thanks a lot for spending your time helping OrgExplorer grow. Keep rocking 🥂 -[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/TODO)](https://github.com/AOSSIE-Org/TODO/graphs/contributors) +[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/OrgExplorer)](https://github.com/AOSSIE-Org/OrgExplorer/graphs/contributors) © 2025 AOSSIE From 43904094455d6e75019ad5864bc54d3defd03bd3 Mon Sep 17 00:00:00 2001 From: yanamavani Date: Wed, 11 Mar 2026 23:34:43 +0530 Subject: [PATCH 2/7] Remove placeholder instruction from README --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 412c43c..2eabf11 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,6 @@ visualize repository statistics such as stars, forks, and contributors. ## 💻 Tech Stack -OrgExplorer: Update based on your project - ### Frontend - React / Next.js / Flutter / React Native - TypeScript From 6cfc769c4be58932e02bfb20545c286b4c6c8a7f Mon Sep 17 00:00:00 2001 From: yanamavani Date: Wed, 11 Mar 2026 23:44:18 +0530 Subject: [PATCH 3/7] Remove placeholder instructions from README --- README.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/README.md b/README.md index 2eabf11..3d992be 100644 --- a/README.md +++ b/README.md @@ -92,8 +92,6 @@ visualize repository statistics such as stars, forks, and contributors. ## ✅ Project Checklist -OrgExplorer: 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. @@ -115,8 +113,6 @@ OrgExplorer: Complete applicable items based on your project type ## 🔗 Repository Links -OrgExplorer: Update with your repository structure - 1. [Main Repository](https://github.com/AOSSIE-Org/OrgExplorer) 2. [Frontend](https://github.com/AOSSIE-Org/OrgExplorer/tree/main/frontend) (if separate) 3. [Backend](https://github.com/AOSSIE-Org/OrgExplorer/tree/main/backend) (if separate) @@ -125,8 +121,6 @@ OrgExplorer: Update with your repository structure ## 🏗️ Architecture Diagram -OrgExplorer: Add your system architecture diagram here - ``` [Architecture Diagram Placeholder] ``` @@ -148,16 +142,12 @@ Example structure to include: ## 🔄 User Flow -OrgExplorer: Add user flow diagrams showing how users interact with your application - ``` [User Flow Diagram Placeholder] ``` ### Key User Journeys -OrgExplorer: Document main user flows: - 1. **User Journey 1**: Description - Step 1 - Step 2 @@ -179,15 +169,12 @@ OrgExplorer: Document main user flows: ### Prerequisites -OrgExplorer: List what developers need installed - - Node.js 18+ / Python 3.9+ / Flutter SDK - npm / yarn / pnpm - [Any specific tools or accounts needed] ### Installation -OrgExplorer: Provide detailed setup instructions #### 1. Clone the Repository @@ -236,7 +223,6 @@ For detailed setup instructions, please refer to our [Installation Guide](./docs ## 📱 App Screenshots -OrgExplorer: Add screenshots showcasing your application | | | | |---|---|---| @@ -254,7 +240,6 @@ Thank you for considering contributing to this project! Contributions are highly ## ✨ Maintainers -OrgExplorer: Add maintainer information - [Maintainer Name](https://github.com/username) - [Maintainer Name](https://github.com/username) From 63251f57ac1120267a1d2dcd2e99947eba3b3fcc Mon Sep 17 00:00:00 2001 From: yanamavani Date: Thu, 12 Mar 2026 01:20:45 +0530 Subject: [PATCH 4/7] docs: fix tech stack section in README --- README.md | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 3d992be..8667f9f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@
AOSSIE - +
  @@ -12,7 +12,7 @@
-[![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/) @@ -68,26 +68,11 @@ visualize repository statistics such as stars, forks, and contributors. ## 💻 Tech Stack ### Frontend -- React / Next.js / Flutter / React Native +- React +- Vite - 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 - --- ## ✅ Project Checklist From 1af9586af7a62baab0082f3603779c2d823afa6c Mon Sep 17 00:00:00 2001 From: yanamavani Date: Thu, 12 Mar 2026 11:47:20 +0530 Subject: [PATCH 5/7] Clean up README by removing placeholders --- README.md | 43 ++++++++++++++----------------------------- 1 file changed, 14 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 8667f9f..06ffc4a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@
AOSSIE - + OrgExplorer logo
  @@ -77,23 +77,10 @@ visualize repository statistics such as stars, forks, and contributors. ## ✅ Project Checklist -- [ ] **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. - +- [ ] Frontend deployment configured +- [ ] GitHub API integration tested +- [ ] Repository analytics working +- [ ] CI/CD pipeline passing --- ## 🔗 Repository Links @@ -107,7 +94,8 @@ visualize repository statistics such as stars, forks, and contributors. ## 🏗️ Architecture Diagram ``` -[Architecture Diagram Placeholder] +[Architecture Diagram] +[Placeholder – actual diagram will be added once project setup is complete] ``` You can create architecture diagrams using: @@ -129,6 +117,7 @@ Example structure to include: ``` [User Flow Diagram Placeholder] +[Placeholder – real user flows will be documented later] ``` ### Key User Journeys @@ -154,9 +143,12 @@ Example structure to include: ### Prerequisites -- Node.js 18+ / Python 3.9+ / Flutter SDK -- npm / yarn / pnpm -- [Any specific tools or accounts needed] +- Node.js 18+ installed +- npm or yarn or pnpm +- Git installed +- Vite, React, TypeScript +- Optional: Node version manager (nvm) +- GitHub account for API access (if needed) ### Installation @@ -223,13 +215,6 @@ Thank you for considering contributing to this project! Contributions are highly --- -## ✨ Maintainers - - -- [Maintainer Name](https://github.com/username) -- [Maintainer Name](https://github.com/username) - ---- ## 📍 License From f4930f7a9c317a96bdf5850291795955feee29d8 Mon Sep 17 00:00:00 2001 From: yanamavani Date: Thu, 12 Mar 2026 14:17:47 +0530 Subject: [PATCH 6/7] Fix README issues raised in review --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 06ffc4a..58dbbf6 100644 --- a/README.md +++ b/README.md @@ -86,8 +86,6 @@ visualize repository statistics such as stars, forks, and contributors. ## 🔗 Repository Links 1. [Main Repository](https://github.com/AOSSIE-Org/OrgExplorer) -2. [Frontend](https://github.com/AOSSIE-Org/OrgExplorer/tree/main/frontend) (if separate) -3. [Backend](https://github.com/AOSSIE-Org/OrgExplorer/tree/main/backend) (if separate) --- @@ -146,7 +144,6 @@ Example structure to include: - Node.js 18+ installed - npm or yarn or pnpm - Git installed -- Vite, React, TypeScript - Optional: Node version manager (nvm) - GitHub account for API access (if needed) From cb9b124df1de6b7b0158f12d36c8de58dd7d6c96 Mon Sep 17 00:00:00 2001 From: yanamavani Date: Fri, 13 Mar 2026 02:26:15 +0530 Subject: [PATCH 7/7] Fix README issues and add installation guide --- README.md | 56 +++++++------------------------------------ docs/INSTALL_GUIDE.md | 15 ++++++++++++ package-lock.json | 24 +++++++++---------- 3 files changed, 36 insertions(+), 59 deletions(-) create mode 100644 docs/INSTALL_GUIDE.md diff --git a/README.md b/README.md index 58dbbf6..6a76674 100644 --- a/README.md +++ b/README.md @@ -93,49 +93,18 @@ visualize repository statistics such as stars, forks, and contributors. ``` [Architecture Diagram] -[Placeholder – actual diagram will be added once project setup is complete] -``` - -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) - -Example structure to include: -- Frontend components -- Backend services -- Database architecture -- External APIs/services -- Data flow between components +[actual diagram will be added once project setup is complete] +The architecture diagram will be added once the project structure is finalized. +Currently the project follows a simple structure where the frontend interacts with the GitHub API to fetch repository data and display analytics. --- ## 🔄 User Flow ``` -[User Flow Diagram Placeholder] -[Placeholder – real user flows will be documented later] -``` - -### Key User Journeys - -1. **User Journey 1**: Description - - Step 1 - - Step 2 - - Step 3 - -2. **User Journey 2**: Description - - Step 1 - - Step 2 - - Step 3 - -3. **User Journey 3**: Description - - Step 1 - - Step 2 - - Step 3 - ---- +[User Flow Diagram] +## User Flow +User flow diagram will be added in future updates. ## �🍀 Getting Started @@ -169,13 +138,7 @@ 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 -``` +This project currently does not require any environment variables. #### 4. Run the Development Server @@ -189,7 +152,7 @@ pnpm dev #### 5. Open your Browser -Navigate to [http://localhost:3000](http://localhost:3000) to see the application. +Navigate to [http://localhost:5173](http://localhost:5173) to see the application. For detailed setup instructions, please refer to our [Installation Guide](./docs/INSTALL_GUIDE.md) (if you have one). @@ -198,9 +161,8 @@ For detailed setup instructions, please refer to our [Installation Guide](./docs ## 📱 App Screenshots -| | | | -|---|---|---| | Screenshot 1 | Screenshot 2 | Screenshot 3 | +- Screenshots will be added once the application UI is finalized. --- diff --git a/docs/INSTALL_GUIDE.md b/docs/INSTALL_GUIDE.md new file mode 100644 index 0000000..4bc20ee --- /dev/null +++ b/docs/INSTALL_GUIDE.md @@ -0,0 +1,15 @@ +# Installation Guide + +Follow these steps to run OrgExplorer locally. + +## 1. Clone the repository +git clone https://github.com/AOSSIE-Org/OrgExplorer.git + +## 2. Install dependencies +npm install + +## 3. Start the development server +npm run dev + +## 4. Open in browser +http://localhost:5173 \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index ab0e168..adfb99a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "orgexplorer", + "name": "OrgExplorer", "version": "0.0.0", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "orgexplorer", + "name": "OrgExplorer", "version": "0.0.0", "dependencies": { "react": "^19.2.0", @@ -1182,13 +1182,13 @@ } }, "node_modules/@typescript-eslint/typescript-estree/node_modules/minimatch": { - "version": "9.0.5", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", - "integrity": "sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow==", + "version": "9.0.9", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.9.tgz", + "integrity": "sha512-OBwBN9AL4dqmETlpS2zasx+vTeWclWzkblfZk7KTA5j3jeOONz/tRCnZomUyvNg83wL5Zv9Ss6HMJXAgL8R2Yg==", "dev": true, "license": "ISC", "dependencies": { - "brace-expansion": "^2.0.1" + "brace-expansion": "^2.0.2" }, "engines": { "node": ">=16 || 14 >=14.17" @@ -1297,9 +1297,9 @@ } }, "node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", + "version": "6.14.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.14.0.tgz", + "integrity": "sha512-IWrosm/yrn43eiKqkfkHis7QioDleaXQHdDVPKg0FSwwd/DuvyX79TZnFOnYpB7dcsFAMmtFztZuXPDvSePkFw==", "dev": true, "license": "MIT", "dependencies": { @@ -2372,9 +2372,9 @@ } }, "node_modules/minimatch": { - "version": "3.1.2", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", - "integrity": "sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==", + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.5.tgz", + "integrity": "sha512-VgjWUsnnT6n+NUk6eZq77zeFdpW2LWDzP6zFGrCbHXiYNul5Dzqk2HHQ5uFH2DNW5Xbp8+jVzaeNt94ssEEl4w==", "dev": true, "license": "ISC", "dependencies": {