docs: improve README.md documentation

README.md

@@ -4,15 +4,15 @@
 <!-- Organization Logo -->
 <div align="center" style="display: flex; align-items: center; justify-content: center; gap: 16px;">
   <img alt="AOSSIE" src="public/aossie-logo.svg" width="175">
-  <img src="public/todo-project-logo.svg" width="175" />
+  <img src="public/org-explorer-logo.svg" width="175" alt="OrgExplorer logo" />
 </div>
 
 &nbsp;
 
 <!-- Organization Name -->
 <div align="center">
 
-[![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/)
 
 <!-- Correct deployed url to be added -->
 
@@ -48,155 +48,82 @@
 ---
 
 <div align="center">
-<h1>TODO: Project Name</h1>
+<h1>OrgExplorer</h1>
 </div>
 
-[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
-
 ### 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
 
-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.
-
+- [ ] Frontend deployment configured
+- [ ] GitHub API integration tested
+- [ ] Repository analytics working
+- [ ] CI/CD pipeline passing
 ---
 
 ## 🔗 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
-
 ```
-[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)
-
-Example structure to include:
-- Frontend components
-- Backend services
-- Database architecture
-- External APIs/services
-- Data flow between components
+[Architecture Diagram]
+[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
 
-TODO: Add user flow diagrams showing how users interact with your application
-
-```
-[User Flow Diagram Placeholder]
 ```
-
-### Key User Journeys
-
-TODO: Document main user flows:
-
-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
 
 ### Prerequisites
 
-TODO: List what developers need installed
-
-- 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
+- Optional: Node version manager (nvm)
+- GitHub account for API access (if 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
@@ -211,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
 
@@ -231,19 +152,17 @@ 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).
 
 ---
 
 ## 📱 App Screenshots
 
-TODO: Add screenshots showcasing your application
 
-|  |  |  |
-|---|---|---|
 | Screenshot 1 | Screenshot 2 | Screenshot 3 |
+- Screenshots will be added once the application UI is finalized.
 
 ---
 
@@ -255,14 +174,6 @@ Thank you for considering contributing to this project! Contributions are highly
 
 ---
 
-## ✨ Maintainers
-
-TODO: Add maintainer information
-
-- [Maintainer Name](https://github.com/username)
-- [Maintainer Name](https://github.com/username)
-
----
 
 ## 📍 License
 
@@ -273,8 +184,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 

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