https://github.com/prodev717/dev-summary
Summarize GitHub profiles easily. Get a brief overview of a developer's repositories, skills, and README content with our GitHub profile summary tool Dev Summary.
https://github.com/prodev717/dev-summary
api flask gemini-api githubapi htmx jinja2 json python tailwindcss waitress wsgi-server
Last synced: 14 days ago
JSON representation
Summarize GitHub profiles easily. Get a brief overview of a developer's repositories, skills, and README content with our GitHub profile summary tool Dev Summary.
- Host: GitHub
- URL: https://github.com/prodev717/dev-summary
- Owner: prodev717
- License: mit
- Created: 2024-12-27T15:23:49.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-15T17:07:47.000Z (3 months ago)
- Last Synced: 2025-03-29T12:11:34.025Z (about 1 month ago)
- Topics: api, flask, gemini-api, githubapi, htmx, jinja2, json, python, tailwindcss, waitress, wsgi-server
- Language: Python
- Homepage: https://devsummary.onrender.com/
- Size: 1.86 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dev Summary
Get a brief overview of a developer's repositories skills and README content with our GitHub profile summary tool Dev Summary.
🚀 Demo
[https://devsummary.onrender.com/](https://devsummary.onrender.com/)
Project Screenshots:
🧐 Features
Here're some of the project's best features:
* User-Friendly UI/UX: Intuitive and responsive interface powered by Tailwind CSS and HTMX for seamless interaction.
* AI-Generated Summary: Provides detailed analysis and insights into developer skills using the Gemini API.
* JSON API Endpoint: Exposes a RESTful endpoint to fetch the AI-generated summary in JSON format for integration.
🛠️ Installation Steps:
1. Clone the Repository
```
git clone https://github.com/prodev717/dev-summary
```
2. Navigate to the cloned directory
```
cd dev-summary
```
3. Install Required Dependencies
```
pip install -r requirements.txt
```
4. Configure Environment Variables By Creating .env File
```
GEMINI_API_KEY=your-gemini-api-key
GITHUB_API_KEY=your-github-api-key
```
5. Start The Server
```
waitress-serve --host 0.0.0.0 --port 8000 main:app
```
🍰 Contribution Guidelines:
To contribute first fork the repository and clone it to your local machine. Create a new branch for your changes then make and test your modifications while following the project's coding style. Commit your changes with a clear message and push your branch to your fork. Afterward create a pull request with a description of your changes. Once it’s reviewed it will be merged.
💻 Built with
Technologies used in the project:
* python
* flask
* htmx
* tailwind CSS
🛡️ License:
This project is licensed under the MIT License
📝 Note:
This project is now actively maintained and developed by [TeamX](https://github.com/TeamXVit) as Git2Know.
You can find the latest version and updates here: [TeamX/git2know](https://github.com/TeamXVit/git2know).