Skip to content

README: updated tech, theme, structure, URL #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
opencode-agent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: updated tech, theme, structure, URL #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ View PRs that reference your issue, with:
- Deployment status tracking
- GitHub Actions run visibility

### Theme Support

Toggle between light, dark, and system themes for comfortable viewing in any environment.

### Comment with AI Agents

From any related PR, type your command and mention an agent:
Expand All @@ -70,7 +74,7 @@ The "Send @jules" button automatically appends the agent mention to your comment

```bash
# Clone and install
git clone https://github.com/yourusername/VibeGithub.git
git clone https://github.com/friuns/VibeGithub.git
cd VibeGithub
npm install

Expand Down Expand Up @@ -144,7 +148,10 @@ Agents that work with this pattern:
│ ├── Button.tsx
│ ├── Markdown.tsx
│ ├── RepoCard.tsx # Repo card with issue previews
│ ├── ThemeToggle.tsx # Theme switching component
│ └── Toast.tsx
├── contexts/
│ └── ThemeContext.tsx # Theme state management
├── services/
│ ├── firebaseService.ts # GitHub OAuth via Firebase
│ ├── githubService.ts # GitHub API (issues, PRs, workflows)
Expand All @@ -154,16 +161,23 @@ Agents that work with this pattern:
│ ├── Dashboard.tsx # Repository list
│ ├── RepoDetail.tsx # Issues + New Issue modal
│ └── IssueDetail.tsx # Issue view + @jules commenting
├── constants.ts
├── metadata.json
├── tsconfig.json
├── vite.config.ts
└── types.ts
```

## Tech Stack

- **React 18** + TypeScript
- **Vite** for fast builds
- **React 19** + TypeScript
- **Vite 6** for fast builds
- **Tailwind CSS** for styling
- **Firebase Auth** for GitHub OAuth
- **GitHub REST API** for repository operations
- **Lucide React** for icons
- **React Markdown** for rendering markdown
- **Recharts** for data visualization

## License

Expand Down