https://github.com/christimperley/commit-culture
A simple GitHub repo scanner that assesses for SWE best practices and good teamwork
https://github.com/christimperley/commit-culture
Last synced: 8 months ago
JSON representation
A simple GitHub repo scanner that assesses for SWE best practices and good teamwork
- Host: GitHub
- URL: https://github.com/christimperley/commit-culture
- Owner: ChrisTimperley
- License: gpl-3.0
- Created: 2025-09-26T21:45:21.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-10-03T02:42:55.000Z (8 months ago)
- Last Synced: 2025-10-03T04:23:21.611Z (8 months ago)
- Language: TypeScript
- Size: 396 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Commit Culture
A web application that analyzes GitHub repositories to assess team collaboration and development culture. View detailed metrics about pull requests, issues, and contributor activity through an interactive dashboard.
## Features
- 📊 **Pull Request Analysis**: View PR metrics including lines changed, review activity, and merge patterns
- 🔗 **Issue Tracking**: Browse and analyze GitHub issues with sorting capabilities
- 👥 **Team Collaboration**: Track contributor activity, commits, and participation metrics
- 🌐 **Interactive Dashboard**: Modern React UI with real-time GitHub API integration
## Installation
### Prerequisites
- **Node.js 22+** and **npm 10+**
- GitHub Personal Access Token (recommended for better rate limits)
### Setup
1. **Clone and install**:
```bash
git clone https://github.com/ChrisTimperley/commit-culture.git
cd commit-culture
npm install
```
2. **Configure GitHub token** (optional but recommended):
```bash
# Create environment file
echo "GITHUB_TOKEN=your_github_token_here" > .env
```
3. **Start the application**:
```bash
npm run dev
```
4. **Open your browser** to `http://localhost:3000`
## Usage
1. **Enter a repository**: Type in any public GitHub repository (e.g., `microsoft/vscode`)
2. **View the analysis**: Browse through pull requests, issues, and contributor metrics
3. **Change repositories**: Use the "Change Repository" button in the header to analyze different repos
## GitHub Token Setup
For private repositories and higher rate limits, create a Personal Access Token:
1. Go to [GitHub Settings > Personal Access Tokens](https://github.com/settings/tokens)
2. Click "Generate new token (classic)"
3. Select scopes: `public_repo` (or `repo` for private repositories)
4. Copy the token and add it to your `.env` file
## Development
### Available Scripts
- `npm run dev` - Start development server (frontend + backend)
- `npm run build` - Build the application
- `npm run test` - Run tests
- `npm run lint` - Check code style
### DevContainer Support
This project includes VS Code DevContainer configuration for a complete development environment.
## License
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.