search

ajnart / homarr

Customizable browser's home page to interact with your homeserver's Docker containers (e.g. Sonarr/Radarr)
https://homarr.dev
MIT License
6.16k stars 284 forks source link

More detailed contribution guidance #2144

Closed hucknz closed 1 month ago

hucknz commented 1 month ago

Description

Hi, I'd like to contribute a widget but I'm struggling with the contribution process, particularly around local builds for testing.

I have read through the Developer Guides documentation and there's great information around the IDE, etc. but I can't see anything about how to build locally.

I've also looked through the github issues and can see that building locally seems to be discouraged and there's not much in the way of guidance on how to do that.

I've also tried unpicking the github actions to do my own build but am encountering a lot of errors during that process and when the build does succeed my widget isn't included in the build.

I'm not a frontend developer so this is a little outside my normal world and I'm really struggling to get a local build going so I can test my widget out before I contribute a PR. Is there any guidance you can provide, or additions to the developer documentation, that can help me get started?

Priority

Medium (Would be very useful)

github-actions[bot] commented 1 month ago

Hi 👋. Thank you for submitting your first issue to Homarr. Please ensure that you've provided all nessesary information. You can use the three dots > Edit button to update your post with additional images and information. Depending on the current volume of requests, the team should get in conact with you shortly.

manuel-rw commented 1 month ago

Hi, this is the wrong repository. You should open issues for documentation in homarr-labs/documentation. I agree, documentation around local development could be better. I strongly recommend you to develop in the new version of Homarr (see #1993), available at homarr-labs/homarr. This code repository will be archived soon. If you need help for development, I also suggest you to join the Discord. The developer guides will not be updated for <1.0 because that version will not live for much longer. It will be updated as soon 1.0 is released. Let me know if this answers your question and if you need further assistance.

hucknz commented 1 month ago

Ok, thanks for the response. I wasn't aware there was a v2 on the way so I'll take a look at that and create an issue there if I still need assistance.