GitHubProfileViewer

Intro. to GitHubProfileViewer Project

GitHubProfileViewer was built to support recruiters and hiring managers in making more informed decisions. While AI tools can automate resume screening and data visualization, they often miss the nuance of real code. This app fills that gap by offering a clearer look into a developer’s actual work—directly from GitHub. By visualizing the most-used programming languages across repositories (excluding forked repos), recruiters can assess not just what a candidate says they know, but what they’ve actually built.

Technical Setup Guide:

0. Clone the Repos

     $ git clone https://github.com/hon-nova/GitHubProfileViewer
     $ cd GitHubProfileViewer

1. Frontend Setup:

   From the project root:

   a. Navigate to the frontend directory
   b. Install dependencies
   c. Run the server (if successful, access the app locally at http://localhost:5173/ by default)

     $ cd githubprofileviewer
     $ npm i
     $ npm run dev

2. Backend Setup (Mac OS):

   a. Create a virtual environment (VE) named v_git
   b. Activate the VE
   c. Install required dependencies
   d. Navigate to the backend directory
   e. Run the backend (if all good, access the app locally at: http://127.0.0.1/8000 by default)

     $ python3 -m venv v_git
     $ source v_git/bin/activate
     $ pip install -r requirements.txt     
     $ cd server/
     $ server $ python3 run.py

3. Tech Stack

   Frontend	Backend
   React.js TypeScript	Python
   Tailwind CSS	Flask
   Zustand	PostGreSQL
   D3.js	SQLAlchemy ORM

4. Notes:

   This app depends on GitHub's API, which has strict rate limits for unauthenticated requests. To use the app properly, create a GitHub Personal Access Token and add it to a .env file in the backend directory (GithubProfileViewer/server/.env)

     GITHUB_TOKEN=your_personal_token_here

5. Constraints:

   Currently, the app only uses GitHub as the sole resource to collect developer activity. In the future, the app can be expanded by integrating platforms encompassing GitLab, and Bigbucket to provide a more comprehensive view for users.