Update Onboarding and Readme for local setup for new contributors
š The feature
We should update the Onboarding and readme for new contributors.
Motivation, pitch
Many new contributors are facing the issue for setting up local environment for contribution.
š Hello @uju09!
Thank you for opening this issue. Our team will review it soon. š
- If you can, please provide more details like steps to reproduce, expected vs. actual behavior, and screenshots (if applicable). š
We appreciate your contribution! š”
@M4dhav Many new contributors are facing issue of setting Resonate locally. I think we should automate it. If you think we need this, then please assign it to me.
Resonate Setup is failing on a case to case basis with different reasons. An automated setup script for the backend already exists, so what would the differences be in this one?
@M4dhav For frontend.
In my opinion a script would be unnecessary, as the user only has to run flutter pub get and then flutter run to compile the frontend. However, since new users are having issues setting up the project, it might be a good idea to update the ONBOARDING and Readme documentations to clearly specify Java and Flutter versions Resonate is known to be working with
Ok if this is the issue and let's fix it. Should I start work on it?
Yeah, edit this issue and I'll assign it to you
@M4dhav I edited the issue. i request you to assign it to me.
Hi, I would like to work on this issue. I see this involves updating the README / onboarding instructions for new contributors. I am comfortable with GitHub contributions, and Iād like to take this up. Please assign this issue to me. Thank you!