Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Idea: Add a demo website #219

Open
tranquochuy645 opened this issue Dec 28, 2024 · 12 comments
Open

Idea: Add a demo website #219

tranquochuy645 opened this issue Dec 28, 2024 · 12 comments
Assignees
Labels
enhancement New feature or request

Comments

@tranquochuy645
Copy link
Contributor

I think adding a demo website using github pages would be nice.

People can paste link to a public repo, or upload a repository's archive to get repomix's output that they can easily copy without installing anything.

@tranquochuy645 tranquochuy645 changed the title Idea; Add a demo website Idea: Add a demo website Dec 28, 2024
@yamadashy
Copy link
Owner

yamadashy commented Dec 28, 2024

Hi @tranquochuy645! Thanks as always for your great suggestions!

Actually, I've been thinking about this idea as well. I've been considering a few approaches:

While we could use Stackblitz to emulate the console in the browser, I think having a uithub.com -like experience where users can simply input a URL and get results would be more convenient and user-friendly.

I've already secured the repomix.dev domain, and the current plan is to:

  1. First create an LP and documentation using Vitepress
  2. Later integrate the demo into the landing page

I'd really appreciate your help with this if you're interested in contributing!
While I haven't been able to work on this recently due to other commitments, I'm planning to start development.

@yamadashy yamadashy added the enhancement New feature or request label Dec 29, 2024
@yamadashy yamadashy self-assigned this Dec 29, 2024
@gaby
Copy link
Contributor

gaby commented Jan 4, 2025

@yamadashy The website needs a field for --include patterns. Else the output may be too big to even use with ChatGPT.

@gaby
Copy link
Contributor

gaby commented Jan 4, 2025

For example, I'm a maintainer for https://github.com/gofiber/fiber Since I can only exclude with the website, this is the result of repomix.

Repository Info
Repository gofiber/fiber
Generated At 1/4/2025, 12:42:50 AM
Format plain
Pack Summary
Total Files
237 files
Total Size
1,043,375 chars
Total Tokens
263,244 tokens

263k tokens is too much for most AI tools

@yamadashy
Copy link
Owner

Hi @gaby!

Thanks so much for the feedback! You're absolutely right, an --include pattern field is needed, especially for larger repositories.

I'll add this to the list and plan to implement it soon. I appreciate your suggestion and the example!

@yamadashy
Copy link
Owner

Hi @gaby!

You can now use it.

Thanks again for your feedback! 🙏

image

@gaby
Copy link
Contributor

gaby commented Jan 4, 2025

@yamadashy that was quick! Thank you 💪💪💪

@yamadashy
Copy link
Owner

Hi @tranquochuy645!

I wanted to let you know that the demo website you suggested is now live!
You can check it out here: repomix.com

It's currently a lightweight demo to show the basic usage, but we plan to add more features and documentation in the future.
I'd love to hear your thoughts and feedback on it. Please take a look when you have a chance!

@tranquochuy645
Copy link
Contributor Author

Great work, @yamadashy!

This is really close to what I had in mind, and the UI looks even better than expected!

However, packing an archive (.zip) isn’t available yet. I’m curious if it’s something that might be added soon. I’d love to hear your thoughts on this feature. I’m really invested in the project and would be happy to assist whenever I can.

Once again, great job! You nailed it and delivered so quickly!

@yamadashy
Copy link
Owner

yamadashy commented Jan 6, 2025

@tranquochuy645
Oh, you're right - I completely forgot about the ZIP upload functionality! And I actually want this feature too!

It would be great if we could implement direct directory uploads. I'm wondering if this would be feasible.

I'll add the ZIP upload feature to our next set of tasks!

@gaby
Copy link
Contributor

gaby commented Jan 6, 2025

@yamadashy Another thing that is missing is specifying a branch.

I also notice that when in mobile, request will timeout if the repo is too big.

@yamadashy
Copy link
Owner

@gaby
Thanks for the feedback!

Ah, you're right, specifying a branch is definitely something we need to address. I'm wondering which approach would be more user-friendly: should we add a dedicated input field for the branch, or would it be better to parse URLs like this: https://github.com/yamadashy/repomix/tree/branch?

Regarding the timeout issue on mobile with large repos, you're absolutely correct. It seems like we'll need to explore options like using ace.js or similar to render only a portion of the content at a time, rather than trying to load everything at once.

@gaby
Copy link
Contributor

gaby commented Jan 6, 2025

@yamadashy Probably parsing is the best way to do it. Since not all projects use the same default branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants