Docs: Create a boilerplate for start with React Ape

raphamorim / react-ape

🦍• React Renderer to build UI interfaces using canvas/WebGL (TV and Hardware-Accelerated GPU development based)

https://raphamorim.io/react-ape/

MIT License

1.57k stars 48 forks source link

Docs: Create a boilerplate for start with React Ape #43

Open raphamorim opened 4 years ago

raphamorim commented 4 years ago

Create a boilerplate project to start with React Ape. It should be quite simple, just one component and "live reload" working. I'm open to ideas to start the project, but I really don't to add a CLI for it. It can be a script on gh (ex: sh https://github.com/raphamorim/react-ape/raw/scripts/start.sh) that can clone and install the dependencies.

hayanisaid commented 2 years ago

Hi @raphamorim I'm open to help with this issue, this project seems interesting!

raphamorim commented 2 years ago

Hey @hayanisaid thanks for the reply, the boilerplate is already in development process (https://github.com/raphamorim/react-ape/tree/main/packages/app) but there's two things that you could help on it, if you want to.

[ ] Need to find a way to clone this folder only (or the entire repo using git shallow clone) and document the way to do it in the Docs folder as well
[ ] Integrate a navigation API to the app folder (react-router or anything like that)

hayanisaid commented 2 years ago

OK great, I can jump in and help with that

raphamorim commented 2 years ago

@hayanisaid just a FYI: I am moving the app that I've commented above to outside of the react-ape repo. My goal now is to have around 6 different apps (with different features) to demo the renderer. First one is https://github.com/raphamorim/react-ape-photo-gallery , feel free to add the router changes in the react-ape or https://github.com/raphamorim/react-ape-photo-gallery . Both will work. (Related #115)

hayanisaid commented 2 years ago

@raphamorim I'm still trying to figure out the Navigation thing, react-router is not compatible with react-ape since they both use different DOMs, and react-router component don't render on the screen!

raphamorim commented 2 years ago

Yup, maybe you would like to try something like https://reactnavigation.org/docs/getting-started (before this used to be more agnostic now I guess it's dependent of react-native). Wonder if would be better to write a logic as a module to React Ape since will be quite important have it fixed.

hayanisaid commented 2 years ago

@raphamorim I can't work on navigation module right now, I'm still learning about the library, but I can work on improving the documentations and create examples. also I can take a look #117 and #118