GitXplorer

Web application to explore GitHub organizations and their repositories with ease, integrated with GitHub REST API.

Motivation

The motivation behind GitXplorer is to create a seamless and efficient way to explore GitHub organizations and their repositories. As developers, we often need to search for specific organizations, view their details, and open their repositories. Existing tools and interfaces can be cumbersome and slow. GitXplorer aims to streamline this process, making it faster and more intuitive to find GitHub organizations and their repositories.

Features

• Quick search and filter of GitHub organizations and their repositories.
• Detailed view of organization and repository information.
• Configurable theme, it will respect the system's theme initially, but you can always change it.
• Utilization of Server Components and Client Components for maximum performance.
• Fully responsive and user-friendly interface with a modern design.

Tech Stack

• Next.js as the React framework for the web
• Shadcn UI as the component-based UI library
• GitHub Actions as the CI/CD part of the application
• Vercel as the deployment platform

Requirements

You only need these software packages to run this application:

• Node.js
• Bun (optional — you can use another package manager like npm, yarn, etc.)

Development

To start development quickly, please follow the steps below:

git clone https://github.com/akmalhisyammm/gitxplorer.git
cd gitxplorer
bun install
bun dev

To create a production build, follow these steps:

bun run build
bun start

Tests

There are two test libraries used in this project, Vitest for unit tests and Playwright for end-to-end tests.

To run unit tests, do the commands below:

bun run test
bun test:ci

To run end-to-end tests, do the commands below:

bun e2e
bun e2e:ci

Credits

• Icons made by Flaticon.

License

This project is licensed under the MIT License. Please see the LICENSE for more information.