How to go about local development of react-p5?

[Hahlh]

Hey @Gherciu !

Thank again for your work!

Could you elaborate on how to go about local development of the package?

I wanted to create this issue specifically for getting to know more about how to develop react-p5 locally. Forking it, then including the fork as a dependency in package.json doesn't seem to work as there are some built steps missing that go along with npm publish?

Including information about development in the docs

So far the docs only include information on how to contribute to the project, but not how to do successful local development.

This could be awesome additional information for the docs as it would allow many more people to contribute.

(if you prefer to move this issue to the discussion feature of Github, please feel free to do so)

[gherciu]

@Hahlh Hi, Thanks for this suggestion, that's a good idea.

To improve this process I think I'll include some testing tools like jest and react-testing-library .......also I'll include a new folder named example which will use the local version of react-p5 ready to be manually tested with new code in the browser.

About the publishing process... This process is automated, in .github/ folder we have a GitHub action that builds and publish react-p5 each time when we merge new fixes/features in main branch.

[Hahlh]

Awesome! That sounds like a great plan!

So the step by step would be simple cloning the repo, improving react-p5 that is stored in example and then committing the changes?

[gherciu]

@Hahlh I've already added some tests and merged them in the main branch....so now the testing process should be easier..

About example folder I think I'll use just Next js to be able also to see how it behaves in SSR mode ;)

[Hahlh]

Are Next and Gatsby identical in their approach?

I know that Next has much broader options when it comes to SSR. Does Next also offer to render at build time?

What would your step by step for local development of react-p5 be?

1. Fork the react-p5 repository
2. Clone your fork down
3. Add you fork repository of react-p5 to your package.json
4. npm i
5. Make changes to how react-p5 works
6. Commit changes to your repo
7. Make pull request to the main react-p5

Something like this?