https://github.com/coder-ralph/repotree
A tool that generates a clean ASCII representation of a GitHub repository structure, perfect for documentation and sharing.
https://github.com/coder-ralph/repotree
ascii ascii-tree-generator nextjs open-source repotree
Last synced: 9 months ago
JSON representation
A tool that generates a clean ASCII representation of a GitHub repository structure, perfect for documentation and sharing.
- Host: GitHub
- URL: https://github.com/coder-ralph/repotree
- Owner: coder-ralph
- License: mit
- Created: 2024-11-13T13:05:04.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-27T14:40:19.000Z (about 1 year ago)
- Last Synced: 2025-03-23T23:35:05.922Z (10 months ago)
- Topics: ascii, ascii-tree-generator, nextjs, open-source, repotree
- Language: TypeScript
- Homepage: https://ascii-repotree.vercel.app
- Size: 9.51 MB
- Stars: 14
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RepoTree
A simple tool to visualize GitHub repositories. It helps developers easily explore and understand their project structures.
## Features
- Clean ASCII view of GitHub repository structure.
- Interactive tree view for easy navigation.
- Download options in various formats.
- Real-time search to find files or folders quickly.
- Dark and Light themes for better readability.
- Easy to use and no installation required.
## Usage
1. Visit [RepoTree](https://ascii-repotree.vercel.app/).
2. Enter the GitHub repository URL.
3. Click on the `Generate` button.
4. Explore the repository structure.
5. Download the tree in various formats.
### Download Options
- **README**: Download the tree in README format.
- **Text**: Download the tree in text format.
- **JSON**: Download the tree in JSON format.
- **HTML**: Download the tree in HTML format.
## Development
1. Clone the repository:
```bash
git clone
```
2. Install the dependencies:
```bash
npm install
```
3. Run the development server:
```bash
npm run dev
```
4. Open [http://localhost:3000](http://localhost:3000) in your browser.
## Contributing
Contributions are welcome! Report issues [here](https://github.com/coder-ralph/RepoTree/issues) or submit a pull request [here](https://github.com/coder-ralph/RepoTree/pulls).
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/coder-ralph/RepoTree/blob/main/LICENSE) file for details.
## Acknowledgements
This project was inspired by Nathan Friend's [Tree Online](https://gitlab.com/nfriend/tree-online) and [ASCII Tree Generator](https://ascii-tree-generator.com/).
## Support
⭐ If you find this project helpful, give it a star!