Get a brief overview of a developer's repositories skills and README content with our GitHub profile summary tool Dev Summary.
https://devsummary.onrender.com/
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.
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
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.
Technologies used in the project:
- python
- flask
- htmx
- tailwind CSS
This project is licensed under the MIT License