|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# RepoTree |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +A simple tool to visualize GitHub repositories. It helps developers easily explore and understand their project structures. |
4 | 4 |
|
5 | | -First, run the development server: |
| 5 | +## Features |
| 6 | + |
| 7 | +- Clean ASCII view of GitHub repository structure. |
| 8 | +- Interactive tree view for easy navigation. |
| 9 | +- Download options in various formats. |
| 10 | +- Real-time search to find files or folders quickly. |
| 11 | +- Dark and Light themes for better readability. |
| 12 | +- Easy to use and no installation required. |
| 13 | + |
| 14 | +## Usage |
| 15 | + |
| 16 | +1. Visit [RepoTree](https://repotree.vercel.app). |
| 17 | +2. Enter the GitHub repository URL. |
| 18 | +3. Click on the `Generate` button. |
| 19 | +4. Explore the repository structure. |
| 20 | +5. Download the tree in various formats. |
| 21 | + |
| 22 | +### Download Options |
| 23 | + |
| 24 | +- **README**: Download the tree in README format. |
| 25 | +- **Text**: Download the tree in text format. |
| 26 | +- **JSON**: Download the tree in JSON format. |
| 27 | +- **HTML**: Download the tree in HTML format. |
| 28 | + |
| 29 | +## Development |
| 30 | + |
| 31 | +1. Clone the repository: |
6 | 32 |
|
7 | 33 | ```bash |
8 | | -npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | | -# or |
14 | | -bun dev |
| 34 | +git clone |
15 | 35 | ``` |
16 | 36 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 37 | +2. Install the dependencies: |
| 38 | + |
| 39 | +```bash |
| 40 | +npm install |
| 41 | +``` |
| 42 | + |
| 43 | +3. Run the development server: |
| 44 | + |
| 45 | +```bash |
| 46 | +npm run dev |
| 47 | +``` |
18 | 48 |
|
19 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 49 | +4. Open [http://localhost:3000](http://localhost:3000) in your browser. |
20 | 50 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 51 | +## Contributing |
22 | 52 |
|
23 | | -## Learn More |
| 53 | +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). |
24 | 54 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 55 | +## License |
26 | 56 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 57 | +This project is licensed under the MIT License. See the [LICENSE](https://github.com/coder-ralph/RepoTree/blob/main/LICENSE) file for details. |
29 | 58 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 59 | +## Acknowledgements |
31 | 60 |
|
32 | | -## Deploy on Vercel |
| 61 | +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/). |
33 | 62 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 63 | +## Support |
35 | 64 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 65 | +⭐ If you find this project helpful, give it a star! |
0 commit comments