GitBrowse

GitBrowse enables you to quickly search for any public GitHub repository or project and view all relevant details, such as repository status, stars, forks, issues, and contributors. If you want to explore a repository in depth, click, and you'll be redirected to the repository on GitHub.

Features

• 🔍 Repository Search: Find any public GitHub repository or project by name or keyword
• 📊 Repository Details: Instantly view repository status, stars, forks, open issues, main language, and more
• 👥 Contributors & Activity: See key contributors and latest activity snapshots
• 🔗 Direct GitHub Access: Click any listed repository to be redirected to its GitHub page for in-depth exploration
• 🌟 Responsive UI: Fast, accessible, and mobile-friendly interface

Getting Started

Prerequisites

• Node.js (v16+ recommended)
• npm, pnpm, or yarn
• Bun (optional, for ultra-fast install and run)

Installation

1. Clone the repository:

   git clone https://github.com/YOUR-USERNAME/gitbrowse.git
   cd gitbrowse
   

2. Install dependencies:

   • With npm:

     npm install
     

   • Or with pnpm:

     pnpm install
     

   • Or with yarn:

     yarn install
     

   • Or with Bun (optional, ultra-fast):

     bun install
     

Running the Development Server

Start the local development server:

• With npm:

  npm run dev
  

• Or with pnpm:

  pnpm dev
  

• Or with yarn:

  yarn dev
  

• Or with Bun:

  bun run dev
  

Open your browser to http://localhost:5173 (or as indicated in your terminal).

Building for Production

To create a production build:

• With npm:

  npm run build
  

• Or with pnpm:

  pnpm build
  

• Or with yarn:

  yarn build
  

• Or with Bun:

  bun run build
  

Preview the built app locally:

npm run preview
# or
pnpm preview
# or
yarn preview
# or
bun run preview

To deploy your app, you may need to install a SvelteKit adapter for your target environment.

Configuration

GitBrowse uses the public GitHub API. For increased rate limits and private repo access, create a .env file and add your GitHub personal access token:

VITE_GITHUB_TOKEN=your_token_here

Contributing

1. Fork this repository
2. Create a new branch: git checkout -b feature/my-feature
3. Make your changes and commit: git commit -am 'Add new feature'
4. Push to your branch: git push origin feature/my-feature
5. Open a pull request

All contributions are welcome! Please open issues for bugs or feature requests.

License

Licensed under the Apache License, Version 2.0.