Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Hiroki-org/github-user-summary

Repository files navigation

GitHub User Summary

Unlock Your GitHub Profile! Explore user profiles, visualize contributions, and analyze coding habits with a beautiful, data-driven summary.

Features

  • Profile Analysis: Gain insights into any GitHub user's profile.
  • Contribution Visualization: View contribution graphs and statistics in an engaging format.
  • Data-Driven Summary: Understand coding habits and language usage.
  • Modern UI: Built with Next.js App Router and Tailwind CSS for a sleek, responsive design.
  • Dynamic Theming: Extracts colors from user avatars to create personalized themes.
  • Fast & Reliable: Utilizes GitHub GraphQL API with REST fallbacks for optimal performance.

Tech Stack

Getting Started

Prerequisites

  • Node.js (v20 or newer recommended)
  • npm, yarn, pnpm, or bun

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/github-user-summary.git
    cd github-user-summary
  2. Install dependencies:

    npm install
  3. Set up environment variables: Create a .env.local file in the root directory and add the necessary environment variables (e.g., for NextAuth and GitHub API access). For local development, you may need a dummy secret:

    export NEXTAUTH_SECRET=mysecret123
  4. Start the development server:

    npm run dev
  5. Open http://localhost:3000 with your browser to see the application.

Testing & Verification

This project uses Vitest for unit testing.

  • Run tests:
    npm test
  • Run linting:
    npm run lint
  • Build the project:
    npm run build

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is open source and available under the MIT License.

Releases

No releases published

Packages

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /