IndoGitHubers

README

🏆 IndoGitHubers

Desktop	Mobile

📋 Description

IndoGitHubers is an application that displays the GitHub rank of users in Indonesia. It provides detailed information about each user, including their number of followers and contributions. The IndoGitHubers app fetches data from the GitHub API and displays it in a user-friendly format. The app allows users to sort the list of users by different criteria and search for specific users.

💡 Features

Badge: You can embed your GitHub rank. more details
GitHub Rank: The app displays the GitHub rank of users in Indonesia. This includes their number of followers and contributions.
Sorting: Users can sort the list of users by different criteria, such as the number of followers or contributions.
Search: Users can search for specific users using the search bar.

🖼️ Showcases

Check out the GitHub users who are standing out with the IndoGitHubers-badge on their public profiles:

Click to expand!

🧑‍💻 Running Locally

Prerequisites

Node.js, minimum v20.18.0
NPM (included in Node.js), minimum v10.8.2

Clone the repo

git clone https://github.com/depapp/indogithubers.git

Then navigate to the project directory

cd indogithubers

Install the dependencies

npm run install

Run the app

npm run dev

Run E2E Test

We have several command to working with E2E:

npm run test:setup, You need to run at least once (if needed).
npm run test:e2e, Run all the test case inside this project.
npm run test:e2e:smoke, Run all the test case that is included as smoke test group.
npm run test:e2e:desktop, Run using desktop device only.
npm run test:e2e:mobile, Run using mobile device only.
npm run test:e2e:report, Run the latest playwright report.

E2E for Visual Test

When developing E2E test that is require visual test snapshot, we need to run in the exact same operating system with the CIs. Since our CI using Ubuntu, we need to run our E2E inside Docker to mimick the same system.

Make sure you have Docker installed
Run command: npm run docker
If you facing error, it because some of optional dependencies are needs to be installed in the proper operating system. You can re-run command npm i inside the bash terminal in your Docker command.
Run the test: npm run e2e
To regenerate the new snapshot, you need to run command: npm run test:e2e -- --update-snapshots

Deploy

Stats

IndoGitHubers Stats

👥 Contributors

If you'd like to contribute to the IndoGitHubers app, you can fork the repository, make your changes, and submit a pull request. Please make sure to follow the existing code style and add tests for any new functionality.