Skip to content

ASaha-os/git-profile

Repository files navigation

THIS PROJECT RUNS ONLY ON LOCALHOST , PLEASE CLONE & RUN

🌟 GitProfile AI

🔍 Discover Your GitHub Identity — Analyze, assess, and enhance your open-source journey with AI-powered insights.

Vercel Deploy Made with React Powered by Vite Auth0 GitHub API


✨ Features

🚀 Feature 🧩 Description
🔐 Auth0 Login with GitHub Securely sign in with your GitHub account
📊 AI-Powered Insights Analyze repositories, commits, and languages
🧠 Skill Assessment Discover your top programming languages and expertise level
💡 Smart Recommendations Get project suggestions and open-source contribution ideas
🌍 Open Source Guidance Learn how to start contributing effectively
⚙️ Built with TypeScript + React + Vite Fast, type-safe, and modern stack

🧰 Tech Stack

Layer Tools
Frontend React, TypeScript, Vite, Tailwind CSS
Auth Auth0 (GitHub OAuth)
API GitHub REST API
AI (Upcoming) Gemini API (for summarization & recommendations)
Deployment Vercel

🔧 Local Development Setup

1️⃣ Clone the Repository

git clone https://github.com/ASaha-os/git-profile.git
cd git-profile

2️⃣ Install Dependencies

npm install
# or
yarn install

3️⃣ Set Up Environment Variables

Create a .env file in the root directory:

VITE_AUTH0_DOMAIN=your-auth0-domain
VITE_AUTH0_CLIENT_ID=your-auth0-client-id
VITE_GITHUB_API_URL=https://api.github.com

💡 Tip: You can obtain your Auth0 credentials from the Auth0 dashboard.


4️⃣ Run the Development Server

npm run dev

Vite will start your app on:
👉 http://localhost:8080


🌐 Deployment

This project is deployed on Vercel 🚀

You can deploy your own instance easily:

vercel deploy

Or connect your GitHub repo to Vercel Dashboard for automatic deployments on every push.


🧭 Project Structure

git-profile/
│
├── public/              # Static assets
├── src/
│   ├── components/      # Reusable React components
│   ├── pages/           # App pages & routes
│   ├── hooks/           # Custom React hooks
│   ├── utils/           # Helper functions (GitHub API, Auth, etc.)
│   ├── App.tsx          # Main app component
│   └── main.tsx         # Entry point (Vite)
│
├── vite.config.ts       # Vite configuration
├── package.json
└── README.md

🎥 Project Presentation

GitProfile Presentation

📽️ Click the image to view the full Canva presentation!


🧩 API Integration

🔒 Authentication

  • Auth0 + GitHub OAuth
  • Secure login flow with token-based authentication.

🧮 GitHub API

  • Fetches:
    • Repositories
    • Commits
    • Languages used
    • Contribution stats

🤖 Gemini AI (Upcoming)

  • Summarizes GitHub activity.
  • Suggests open-source projects to contribute to.
  • Offers personalized insights using AI.

💬 Contribution Guide

Want to contribute? Awesome! 🤝
Contributions are always welcome.

  1. Fork the repo
  2. Create a new branch:
    git checkout -b feature/awesome-feature
  3. Commit your changes:
    git commit -m "✨ Add awesome feature"
  4. Push and open a Pull Request 🚀

🧑‍💻 Author

👋 Developed by Akash Saha

A passionate open-source contributor & MLH hacker ❤️


🌈 Acknowledgements


🪄 License

This project is licensed under the MIT License.
Feel free to use, modify, and share! 💫


⭐ If you like this project, give it a star on GitHub and share it with your fellow hackers!

About

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors