GitHub Repository Viewer is a web application built with React and TypeScript that allows users to view and explore the contents of GitHub repositories. This application utilizes the GitHub API to fetch and display repository data in a user-friendly format.
- Fetch and display repository content using GitHub API
- View file structure in an ASCII tree format
- Display file contents for each file in the repository
- Easy authentication with GitHub personal access token
- Download repository content as a markdown file
- Copy repository content to clipboard
- Modern and user-friendly interface built with Tailwind CSS
Follow these steps to set up and run the project on your local machine:
-
Clone the repository:
git clone https://github.com/U-C4N/GithubtoLLM.git cd GithubtoLLM -
Install the required packages:
npm install -
Start the development server:
npm run dev -
Open your browser and navigate to
http://localhost:5173/to start using the application.
- On the main page, enter your GitHub personal access token.
- Enter the URL of the GitHub repository you want to view.
- Click the "Fetch Repository Content" button.
- The file structure and contents will be displayed in the text area.
- Use the "Download" button to save the content as a markdown file.
- Use the "Copy" button to copy the content to your clipboard.
- React - JavaScript library for building user interfaces
- TypeScript - Typed superset of JavaScript
- Vite - Next generation frontend tooling
- Tailwind CSS - CSS framework
- Lucide React - Icon set
Umutcan Edizaslan:
