🤖 AuthorTrail
AuthorTrail helps you explore your Git repository's history by author. Find and browse files you've contributed to, with quick access to view and edit them.
Note: A majority of the code in this repository was generated with Lovable and Cursor using the Claude 3.5 Sonnet LLM.
Features
- 🔍 Search files by author email
- 📁 Hierarchical file tree visualization
- 📝 Built-in code viewer with syntax highlighting
- 🔗 Quick open in your default editor
- 🎨 Dark mode support
Prerequisites
You'll need to install Bun first:
macOS, Linux, WSL:
curl -fsSL https://bun.sh/install | bashWindows (requires Windows 10 version 1809 or later):
powershell -c "irm bun.sh/install.ps1|iex"
Getting Started
- Clone the repository:
git clone https://github.com/yourusername/authortrail.git
cd authortrail- Install dependencies:
- Start the development server:
- Start the backend server:
How to Use
- Enter the path to your Git repository (e.g.,
/path/to/your/repo) - Input your Git email or click the user icon to auto-fetch from Git config
- Click "Search Files" to find all files you've authored
- Navigate the file tree to view your contributions
- Use the "Open in Editor" button to edit files in your preferred IDE
Tech Stack
- Vite + React
- TypeScript
- shadcn/ui components
- Tailwind CSS
- CodeMirror for code viewing
- Bun for both package management and server runtime
Development
The project structure is organized as follows:
src/
├── components/ # React components
├── pages/ # Page components
├── server/ # Backend server code
├── types/ # TypeScript types
└── utils/ # Utility functions
Contributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
This project is licensed under the MIT License - see the LICENSE file for details.
