Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sarimabbas/authortrail
See all the files you have ever touched in a Git repo
https://github.com/sarimabbas/authortrail
Last synced: about 2 months ago
JSON representation
See all the files you have ever touched in a Git repo
- Host: GitHub
- URL: https://github.com/sarimabbas/authortrail
- Owner: sarimabbas
- License: mit
- Created: 2024-12-22T06:47:22.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-22T10:10:54.000Z (2 months ago)
- Last Synced: 2024-12-22T10:31:03.277Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 6.08 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🤖 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](https://lovable.dev) and [Cursor](https://cursor.so) 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:**
```bash
curl -fsSL https://bun.sh/install | bash
```
**Windows (requires Windows 10 version 1809 or later):**
```powershell
powershell -c "irm bun.sh/install.ps1|iex"
```
## Getting Started
1. Clone the repository:
```bash
git clone https://github.com/yourusername/authortrail.git
cd authortrail
```
2. Install dependencies:
```bash
bun install
```
3. Start the development server:
```bash
bun run dev
```
4. Start the backend server:
```bash
bun run server
```
## How to Use
1. Enter the path to your Git repository (e.g., `/path/to/your/repo`)
2. Input your Git email or click the user icon to auto-fetch from Git config
3. Click "Search Files" to find all files you've authored
4. Navigate the file tree to view your contributions
5. 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
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the LICENSE file for details.