Should allow README's from outside of GitHub and stop assuming GitHub #853

Open uhidontkno opened 17 hours ago

I understand that most would host their code on GitHub, but I host my code on GitLab. Every time I ship my project, I get a readme error because my readme is not hosted on GitHub. It also shows a GitHub logo, which is misleading because it's not on GitHub.

I don't know Next.js but you should instead:

Show icons based on Git Provider (github for github.com, gitlab for gitlab.com, codeberg for codeberg.org, forgejo for nest, etc)
Allow any README.MD file to be displayed (as long as the mimetype is correct) instead of ones from GitHub.

Also the doubloon display should be plural not singular

Well here's the thing as you also know most of the hackclubbers host their code on github (99% +) it is better to use it. I do not say that the other platforms are not useful but it will not be of any help for us to spend our time fixing this while we have other issues.

I hope you understand that, but don't worry I will try to work on this and mark it as enhancement.

PR Welcome!

You could atleast just accept any URL going to a file with a

text/markdown
text/x-markdown
text/plain mimetype for the README

@uhidontkno we def want to support gitlab (& all the other git hosts we can) for high seas! Thanks for flagging these issues.

Just submitted https://github.com/hackclub/high-seas/pull/857 for the pluralization stuff. Looking into those other things now!

Ok, the button text can easily be fixed– that was hard coded just to save time but we can pretty easily add in the other git hosts! As for the "Your git readme isn't loading" that actually looks correct. The help text doesn't help you here because it's showing the github instructions, but we aren't regexing the URL to make sure it's github or anything– we show it when the URL fails to load.

Ah, there it is! Gitlab doesn't like hotlinks to their raw URLs. Maybe host on #cdn in the slack?

That explains why I'm getting the error. I thought you used .startsWith or something. Gonna use my CORS proxy or #cdn for future ships.

Nov 24, 2024 8:55:41 PM Max Wofford @.***>:

Screenshot.2024-11-24.at.20.51.54.png (view on web)[https://github.com/user-attachments/assets/7e3b6ad0-bc97-4a29-81d6-2481587dc646]

Ah, there it is! Gitlab doesn't like hotlinks to their raw URLs. Maybe host on #cdn in the slack?

— Reply to this email directly, view it on GitHub[https://github.com/hackclub/high-seas/issues/853#issuecomment-2496517192], or unsubscribe[https://github.com/notifications/unsubscribe-auth/AUQK6NVE5WY5DB6RUTJZBJ32CJ7RXAVCNFSM6AAAAABSMJGGI2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIOJWGUYTOMJZGI]. You are receiving this because you were mentioned. [Tracking image][https://github.com/notifications/beacon/AUQK6NVLID6BCBTOK2IJXD32CJ7RXA5CNFSM6AAAAABSMJGGI2WGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTUUZXKEQ.gif]

Nah, we actually did build high seas with git{lab|ea} support but there are def some parts of the UI that are hardcoded to show GH because limited developer time. We'll totally accept PRs to polish up the experience though for our other public git host users, or even self-hosted gitserver users!

P.S. https://jhythm.rare1k.dev/mainmenu is sick! Love the UI's clickyness– I kinda want to add those sounds to the high seas UI

Jhythm is on Itch.io too https://rare1k.itch.io/jhythm

Nov 24, 2024 9:06:46 PM Max Wofford @.***>:

P.S. https://jhythm.rare1k.dev/mainmenu is sick! Love the UI's clickyness– I kinda want to add those sounds to the high seas UI

— Reply to this email directly, view it on GitHub[https://github.com/hackclub/high-seas/issues/853#issuecomment-2496527619], or unsubscribe[https://github.com/notifications/unsubscribe-auth/AUQK6NV32DOYXQELYQDYRYT2CKA27AVCNFSM6AAAAABSMJGGI2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIOJWGUZDONRRHE]. You are receiving this because you were mentioned. [Tracking image][https://github.com/notifications/beacon/AUQK6NQOBHAM2NLS6DM4MQT2CKA27A5CNFSM6AAAAABSMJGGI2WGG33NNVSW45C7OR4XAZNMJFZXG5LFINXW23LFNZ2KUY3PNVWWK3TUL5UWJTUUZX6QG.gif]

Oh also, the sound button is behind all the UI stuff so you can't listen to the pirate tunes on mobile

hackclub / high-seas

Should allow README's from outside of GitHub and stop assuming GitHub #853