feat:setup basic project and github api client along with cache #1
Conversation
github-actions
bot
added
documentation
📝 WalkthroughWalkthroughInitializes the OrgExplorer React + Vite + TypeScript app: project config and linting, README content, HTML entry, React bootstrapping, Tailwind/global styles, a GitHub API client with token support, convenience API helpers, and an IndexedDB cache for GitHub responses. New .gitignore entries for LaTeX and related files. Changes
Sequence DiagramsequenceDiagram
participant Browser as Browser / React App
participant Cache as IndexedDB (org-explorer-db)
participant GitHub as GitHub REST API
Browser->>Cache: query "github" store for org data
alt cache hit
Cache-->>Browser: return cached org data
Browser->>Browser: render UI
else cache miss
Browser->>GitHub: GET /orgs/{org} (githubRequest, optional token)
GitHub-->>Browser: org JSON
Browser->>Cache: store org JSON in "github"
Cache-->>Browser: ack
Browser->>Browser: render UI
end
Browser->>Cache: query "github" store for repos
alt cache hit
Cache-->>Browser: return cached repos
else cache miss
Browser->>GitHub: GET /orgs/{org}/repos?per_page=100
GitHub-->>Browser: repos JSON
Browser->>Cache: store repos
Cache-->>Browser: ack
end
Browser->>GitHub: GET /repos/{owner}/{repo}/contributors (when requested)
GitHub-->>Browser: contributors JSON
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🤖 Fix all issues with AI agents
In `@index.html`:
- Line 7: Update the HTML title element to match project branding by changing
the <title> element value from "Orgexplorer" to "OrgExplorer" (modify the
<title> tag in index.html accordingly) so the page title matches the README and
UI naming.
In `@package.json`:
- Around line 12-18: Move the build-time plugin "@tailwindcss/vite" out of the
dependencies block and into devDependencies in package.json: remove the
"@tailwindcss/vite" entry from "dependencies" and add the same version string
under "devDependencies" so that only runtime packages like "react", "react-dom",
"idb", and "tailwindcss" remain in "dependencies".
In `@README.md`:
- Around line 124-133: The headings in README.md use two spaces after the '###'
which markdownlint flags; update the headings "### Explore an Organization
(Default Flow)" and "### Optional Authentication for Higher Rate Limits" to
have a single space after '###' (i.e., "### Explore an Organization (Default
Flow)" and "### Optional Authentication for Higher Rate Limits") so the markdown
complies with markdownlint.
- Around line 90-93: Update the Tech Stack entry under the "### Backend" section
by correcting the capitalization of "Github REST API" to the official spelling
"GitHub REST API"; locate the bullet line "- Github REST API" and replace it
with "- GitHub REST API" so the README uses the correct product name.
- Around line 103-121: The fenced code blocks around the embedded image tags
under "🏗️ Architecture Diagram" and "🔄 User Flow" lack language identifiers;
update each opening triple-backtick before the <img ... /> tags to use ```html
and keep the closing triple-backticks unchanged so linting and readability
improve for the `<img width="1801" ... />` and `<img width="1842" ... />` blocks
in README.md.
In `@src/api/github/client.ts`:
- Around line 7-12: The code currently reads a GitHub PAT from localStorage via
localStorage.getItem("github_token") and injects it into headers (token variable
and headers object); change this to avoid long‑lived localStorage persistence —
read the token from a safer store (prefer sessionStorage or an in‑memory
variable) instead and update the token retrieval site and the Authorization
header construction in the same module (the token constant and headers creation)
to use that safer source; also add a concise comment near the retrieval
explaining the security risk and that persistence should only be used with
explicit opt‑in and documented justification.
- Around line 7-19: The header merging loses non-object headers because it
spreads options.headers; change the logic in src/api/github/client.ts to
normalize headers via the Headers constructor (e.g., new
Headers(options.headers)), then set default "Accept" and conditional
"Authorization" (using the existing token variable) only if they are not already
present, and pass that Headers instance as the headers in the fetch call so
Headers/tuple/object inputs are preserved when calling
fetch(`${GITHUB_API_BASE}${endpoint}`, { ...options, headers }).
In `@src/api/github/org.ts`:
- Around line 3-10: The org parameter is used directly in endpoints in fetchOrg
and fetchOrgRepos which can produce invalid or unsafe URLs; URL-encode the org
value (e.g., via encodeURIComponent) before inserting it into the path templates
so both githubRequest(`/orgs/${...}`) and
githubRequest(`/orgs/${...}/repos?per_page=100`) use the encoded org string.
In `@src/App.tsx`:
- Line 15: The JSX in App.tsx uses className="read-the-docs" which isn't defined
in any CSS; remove the className from the <p> element or add a definition for
`.read-the-docs` in your stylesheet (e.g., App.css or index.css). Locate the <p
className="read-the-docs"> in App.tsx and either delete the className attribute
or create a `.read-the-docs` rule with the intended styles (font, margin, color,
etc.) to resolve the undefined-class warning.
- Line 10: Update the <img> usage in App.tsx to use the Vite public root
absolute path and improve accessibility: change the src from the relative
"../public/aossie-logo.svg" to "/aossie-logo.svg" and replace the empty alt
attribute with a meaningful description (e.g., alt="Aossie logo") or, if
decorative, add aria-hidden="true" instead; locate the img element inside the
App component to apply this change.
🧹 Nitpick comments (4)
.gitignore (1)
28-353: Consider removing LaTeX-related ignore rules.This project is a React + Vite + TypeScript application, yet the
.gitignorecontains extensive LaTeX-related ignore rules (lines 28-352). These appear to be remnants from a template or a different project context and are unnecessary for this codebase.Consider removing these rules to keep the
.gitignorefocused and maintainable.src/api/cache/db.ts (1)
3-10: Consider adding error handling for database initialization.The
dbPromiseexport may reject if IndexedDB is unavailable (e.g., private browsing mode in some browsers, or storage quota exceeded). Consumers of this module should handle potential errors, or you could wrap this with error handling to provide a fallback or clearer error messages.src/api/github/repo.ts (1)
3-5: Consider adding explicit return type annotation.The function lacks a return type, making it implicitly
Promise<any>. Adding explicit types improves API contract clarity and enables better IDE support.💡 Suggested improvement
-export function fetchRepoContributors(owner: string, repo: string) { +export async function fetchRepoContributors(owner: string, repo: string): Promise<Contributor[]> { return githubRequest(`/repos/${owner}/${repo}/contributors`); }You'd need to define a
Contributorinterface matching GitHub's API response schema.src/index.css (1)
52-55: Consider cross-browser focus ring styling.
-webkit-focus-ring-coloris a webkit-specific value that won't work consistently in Firefox. For better cross-browser accessibility, use an explicit color value.♻️ Suggested improvement
button:focus, button:focus-visible { - outline: 4px auto -webkit-focus-ring-color; + outline: 4px auto `#646cff`; }
| <meta charset="UTF-8" /> | ||
| <link rel="icon" type="image/svg+xml" href="/aossie-logo.svg" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Orgexplorer</title> |
There was a problem hiding this comment.
Align the page title with project branding.
Use “OrgExplorer” to match the README and UI naming.
✏️ Proposed fix
- <title>Orgexplorer</title>
+ <title>OrgExplorer</title>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <title>Orgexplorer</title> | |
| <title>OrgExplorer</title> |
🤖 Prompt for AI Agents
In `@index.html` at line 7, Update the HTML title element to match project
branding by changing the <title> element value from "Orgexplorer" to
"OrgExplorer" (modify the <title> tag in index.html accordingly) so the page
title matches the README and UI naming.
| "dependencies": { | ||
| "@tailwindcss/vite": "^4.1.18", | ||
| "idb": "^8.0.3", | ||
| "react": "^19.2.0", | ||
| "react-dom": "^19.2.0", | ||
| "tailwindcss": "^4.1.18" | ||
| }, |
There was a problem hiding this comment.
Move @tailwindcss/vite to devDependencies.
The @tailwindcss/vite package is a build-time plugin and should be listed under devDependencies rather than dependencies. This keeps the production dependency footprint smaller.
🔧 Proposed fix
"dependencies": {
- "@tailwindcss/vite": "^4.1.18",
"idb": "^8.0.3",
"react": "^19.2.0",
"react-dom": "^19.2.0",
"tailwindcss": "^4.1.18"
},
"devDependencies": {
+ "@tailwindcss/vite": "^4.1.18",
"@eslint/js": "^9.39.1",🤖 Prompt for AI Agents
In `@package.json` around lines 12 - 18, Move the build-time plugin
"@tailwindcss/vite" out of the dependencies block and into devDependencies in
package.json: remove the "@tailwindcss/vite" entry from "dependencies" and add
the same version string under "devDependencies" so that only runtime packages
like "react", "react-dom", "idb", and "tailwindcss" remain in "dependencies".
| ### 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 | ||
| - Github REST API | ||
| - Database: idb(for browser indexed db) | ||
|
|
There was a problem hiding this comment.
Fix “GitHub” capitalization in Tech Stack.
Docs should use the official “GitHub” spelling.
✏️ Proposed fix
-### Backend
-- Github REST API
-- Database: idb(for browser indexed db)
+### Backend
+- GitHub REST API
+- Database: idb (browser IndexedDB)🧰 Tools
🪛 LanguageTool
[uncategorized] ~91-~91: The official name of this software platform is spelled with a capital “H”.
Context: ...TypeScript - TailwindCSS ### Backend - Github REST API - Database: idb(for browser in...
(GITHUB)
🤖 Prompt for AI Agents
In `@README.md` around lines 90 - 93, Update the Tech Stack entry under the "###
Backend" section by correcting the capitalization of "Github REST API" to the
official spelling "GitHub REST API"; locate the bullet line "- Github REST API"
and replace it with "- GitHub REST API" so the README uses the correct product
name.
README.md
Outdated
| ## 🏗️ 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 | ||
| <img width="1801" height="1730" alt="image" src="https://github.com/user-attachments/assets/40b1d108-5698-4945-9662-99369f25e8ee" /> | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
|
|
||
| ## 🔄 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: | ||
| <img width="1842" height="4420" alt="image" src="https://github.com/user-attachments/assets/5cbd668f-41d6-4717-8143-8b130cdcae2a" /> | ||
|
|
||
| 1. **User Journey 1**: Description | ||
| - Step 1 | ||
| - Step 2 | ||
| - Step 3 | ||
|
|
||
| 2. **User Journey 2**: Description | ||
| - Step 1 | ||
| - Step 2 | ||
| - Step 3 | ||
| ``` |
There was a problem hiding this comment.
Add language identifiers to fenced code blocks.
Markdownlint flags these fences; using html also improves readability for the embedded <img> tags.
📝 Proposed fix
-```
+```html
<img width="1801" height="1730" alt="image" src="https://github.com/user-attachments/assets/40b1d108-5698-4945-9662-99369f25e8ee" />
-```
+```
-```
+```html
<img width="1842" height="4420" alt="image" src="https://github.com/user-attachments/assets/5cbd668f-41d6-4717-8143-8b130cdcae2a" />
-```
+```🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
106-106: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
117-117: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In `@README.md` around lines 103 - 121, The fenced code blocks around the embedded
image tags under "🏗️ Architecture Diagram" and "🔄 User Flow" lack language
identifiers; update each opening triple-backtick before the <img ... /> tags to
use ```html and keep the closing triple-backticks unchanged so linting and
readability improve for the `<img width="1801" ... />` and `<img width="1842"
... />` blocks in README.md.
| 1. ### Explore an Organization (Default Flow) | ||
| - User opens the application | ||
| - User enters a GitHub organization name | ||
| - Application checks IndexedDB for cached data | ||
| - If cached data exists, it is loaded immediately | ||
| - Otherwise, data is fetched from the GitHub API and cached locally | ||
| - Organization and repository insights are displayed | ||
|
|
||
| 2. ### Optional Authentication for Higher Rate Limits | ||
| - User optionally provides a GitHub Personal Access Token (PAT) |
There was a problem hiding this comment.
Remove extra spaces in ### headings.
Markdownlint flags the double space after the hashes.
📝 Proposed fix
-1. ### Explore an Organization (Default Flow)
+1. ### Explore an Organization (Default Flow)
-2. ### Optional Authentication for Higher Rate Limits
+2. ### Optional Authentication for Higher Rate Limits📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. ### Explore an Organization (Default Flow) | |
| - User opens the application | |
| - User enters a GitHub organization name | |
| - Application checks IndexedDB for cached data | |
| - If cached data exists, it is loaded immediately | |
| - Otherwise, data is fetched from the GitHub API and cached locally | |
| - Organization and repository insights are displayed | |
| 2. ### Optional Authentication for Higher Rate Limits | |
| - User optionally provides a GitHub Personal Access Token (PAT) | |
| 1. ### Explore an Organization (Default Flow) | |
| - User opens the application | |
| - User enters a GitHub organization name | |
| - Application checks IndexedDB for cached data | |
| - If cached data exists, it is loaded immediately | |
| - Otherwise, data is fetched from the GitHub API and cached locally | |
| - Organization and repository insights are displayed | |
| 2. ### Optional Authentication for Higher Rate Limits | |
| - User optionally provides a GitHub Personal Access Token (PAT) |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
124-124: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
132-132: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
🤖 Prompt for AI Agents
In `@README.md` around lines 124 - 133, The headings in README.md use two spaces
after the '###' which markdownlint flags; update the headings "### Explore an
Organization (Default Flow)" and "### Optional Authentication for Higher Rate
Limits" to have a single space after '###' (i.e., "### Explore an Organization
(Default Flow)" and "### Optional Authentication for Higher Rate Limits") so the
markdown complies with markdownlint.
| const token = localStorage.getItem("github_token"); | ||
| //access token from frontend | ||
| const headers: HeadersInit = { | ||
| "Accept": "application/vnd.github+json", | ||
| ...(token ? { Authorization: `Bearer ${token}` } : {}), | ||
| ...options.headers, |
There was a problem hiding this comment.
Avoid persisting GitHub PATs in localStorage.
localStorage is long‑lived and exposed to XSS; a leaked PAT grants API access. Prefer in‑memory or sessionStorage, and document the risk if persistence is required.
🤖 Prompt for AI Agents
In `@src/api/github/client.ts` around lines 7 - 12, The code currently reads a
GitHub PAT from localStorage via localStorage.getItem("github_token") and
injects it into headers (token variable and headers object); change this to
avoid long‑lived localStorage persistence — read the token from a safer store
(prefer sessionStorage or an in‑memory variable) instead and update the token
retrieval site and the Authorization header construction in the same module (the
token constant and headers creation) to use that safer source; also add a
concise comment near the retrieval explaining the security risk and that
persistence should only be used with explicit opt‑in and documented
justification.
| const token = localStorage.getItem("github_token"); | ||
| //access token from frontend | ||
| const headers: HeadersInit = { | ||
| "Accept": "application/vnd.github+json", | ||
| ...(token ? { Authorization: `Bearer ${token}` } : {}), | ||
| ...options.headers, | ||
| }; | ||
|
|
||
|
|
||
| const response = await fetch(`${GITHUB_API_BASE}${endpoint}`,{ | ||
| ...options, | ||
| headers, | ||
| }); |
There was a problem hiding this comment.
Fix header merging for non-object HeadersInit.
...options.headers only works when headers is a plain object; if a caller passes Headers or a tuple array, headers are lost or malformed. Use Headers to normalize and then set defaults.
🛠️ Proposed fix
- const headers: HeadersInit = {
- "Accept": "application/vnd.github+json",
- ...(token ? { Authorization: `Bearer ${token}` } : {}),
- ...options.headers,
- };
+ const headers = new Headers(options.headers);
+ headers.set("Accept", "application/vnd.github+json");
+ if (token) headers.set("Authorization", `Bearer ${token}`);📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| const token = localStorage.getItem("github_token"); | |
| //access token from frontend | |
| const headers: HeadersInit = { | |
| "Accept": "application/vnd.github+json", | |
| ...(token ? { Authorization: `Bearer ${token}` } : {}), | |
| ...options.headers, | |
| }; | |
| const response = await fetch(`${GITHUB_API_BASE}${endpoint}`,{ | |
| ...options, | |
| headers, | |
| }); | |
| const token = localStorage.getItem("github_token"); | |
| //access token from frontend | |
| const headers = new Headers(options.headers); | |
| headers.set("Accept", "application/vnd.github+json"); | |
| if (token) headers.set("Authorization", `Bearer ${token}`); | |
| const response = await fetch(`${GITHUB_API_BASE}${endpoint}`,{ | |
| ...options, | |
| headers, | |
| }); |
🤖 Prompt for AI Agents
In `@src/api/github/client.ts` around lines 7 - 19, The header merging loses
non-object headers because it spreads options.headers; change the logic in
src/api/github/client.ts to normalize headers via the Headers constructor (e.g.,
new Headers(options.headers)), then set default "Accept" and conditional
"Authorization" (using the existing token variable) only if they are not already
present, and pass that Headers instance as the headers in the fetch call so
Headers/tuple/object inputs are preserved when calling
fetch(`${GITHUB_API_BASE}${endpoint}`, { ...options, headers }).
| export function fetchOrg(org:string) { | ||
| return githubRequest(`/orgs/${org}`); | ||
| } | ||
|
|
||
|
|
||
| export function fetchOrgRepos(org:string) { | ||
| return githubRequest(`/orgs/${org}/repos?per_page=100`); | ||
| } |
There was a problem hiding this comment.
Encode org names before building the endpoint.
User input should be URL‑encoded to avoid invalid paths or query/fragment injection.
✅ Proposed fix
export function fetchOrg(org:string) {
- return githubRequest(`/orgs/${org}`);
+ const safeOrg = encodeURIComponent(org);
+ return githubRequest(`/orgs/${safeOrg}`);
}
export function fetchOrgRepos(org:string) {
- return githubRequest(`/orgs/${org}/repos?per_page=100`);
+ const safeOrg = encodeURIComponent(org);
+ return githubRequest(`/orgs/${safeOrg}/repos?per_page=100`);
}🤖 Prompt for AI Agents
In `@src/api/github/org.ts` around lines 3 - 10, The org parameter is used
directly in endpoints in fetchOrg and fetchOrgRepos which can produce invalid or
unsafe URLs; URL-encode the org value (e.g., via encodeURIComponent) before
inserting it into the path templates so both githubRequest(`/orgs/${...}`) and
githubRequest(`/orgs/${...}/repos?per_page=100`) use the encoded org string.
| return ( | ||
| <> | ||
| <div> | ||
| <img src="../public/aossie-logo.svg" alt="" /> |
There was a problem hiding this comment.
Incorrect image path for Vite public assets.
In Vite, files in the public/ directory should be referenced using absolute paths from the root, not relative paths. The current path ../public/aossie-logo.svg will not resolve correctly in production builds.
Additionally, the empty alt="" attribute should provide meaningful alternative text for accessibility, or if the image is purely decorative, consider adding aria-hidden="true".
🔧 Proposed fix
- <img src="../public/aossie-logo.svg" alt="" />
+ <img src="/aossie-logo.svg" alt="AOSSIE logo" />📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <img src="../public/aossie-logo.svg" alt="" /> | |
| <img src="/aossie-logo.svg" alt="AOSSIE logo" /> |
🤖 Prompt for AI Agents
In `@src/App.tsx` at line 10, Update the <img> usage in App.tsx to use the Vite
public root absolute path and improve accessibility: change the src from the
relative "../public/aossie-logo.svg" to "/aossie-logo.svg" and replace the empty
alt attribute with a meaningful description (e.g., alt="Aossie logo") or, if
decorative, add aria-hidden="true" instead; locate the img element inside the
App component to apply this change.
|
|
||
| <h1 className='mt-10'>Org-Explorer</h1> | ||
|
|
||
| <p className="read-the-docs"> |
There was a problem hiding this comment.
Undefined CSS class read-the-docs.
The class read-the-docs is referenced but not defined in App.css or index.css. This appears to be a leftover from the Vite starter template. Either define the class or remove it.
🤖 Prompt for AI Agents
In `@src/App.tsx` at line 15, The JSX in App.tsx uses className="read-the-docs"
which isn't defined in any CSS; remove the className from the <p> element or add
a definition for `.read-the-docs` in your stylesheet (e.g., App.css or
index.css). Locate the <p className="read-the-docs"> in App.tsx and either
delete the className attribute or create a `.read-the-docs` rule with the
intended styles (font, margin, color, etc.) to resolve the undefined-class
warning.
Updated architecture and user flow diagrams in README
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
README.md (3)
142-142: Fix the corrupted heading character.The heading renders as “## �🍀 Getting Started”, which indicates a broken/invalid character and will display inconsistently across renderers. Replace it with a valid emoji or plain text.
✅ Proposed fix
-## �🍀 Getting Started +## 🍀 Getting Started
154-173: Correct the step numbering in Installation.The sequence jumps from 1 → 3 → 4 → 5, which is confusing and looks unpolished. Renumber these steps to be consecutive.
✅ Proposed fix
-#### 1. Clone the Repository +#### 1. Clone the Repository @@ -#### 3. Install Dependencies +#### 2. Install Dependencies @@ -#### 4. Run the Development Server +#### 3. Run the Development Server @@ -#### 5. Open your Browser +#### 4. Open your Browser
15-17: Remove TODO placeholders or replace with real project details.The README still contains placeholders (badge URL, “TODO” prerequisites, contributors link to TODO repo). This makes the documentation feel incomplete and can mislead users.
✅ Proposed fix (examples — replace with real values)
-[](https://TODO.aossie.org/) +[](https://orgexplorer.aossie.org/) -TODO: List what developers need installed +- Git +- Node.js 18+ +- npm / yarn / pnpm -Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂 +Thanks a lot for spending your time helping OrgExplorer grow. Keep rocking 🥂 -[](https://github.com/AOSSIE-Org/TODO/graphs/contributors) +[](https://github.com/AOSSIE-Org/OrgExplorer/graphs/contributors)Also applies to: 146-146, 221-223
1 participant
Description:
This PR initializes the project with a TypeScript-based Vite setup and adds the initial structure for GitHub data access.
Additional Changes included:
Initialized a Vite + React + TypeScript + tailwind project
Added basic project configuration and dependencies
Introduced an initial github and cache module with placeholders for:
API client setup
Organization-level requests
Repository-level requests
Checklist
Summary by CodeRabbit
New Features
Documentation
Chores
✏️ Tip: You can customize this high-level summary in your review settings.