infinitered / solidarity-react-native

Solidarity snapshot plugin for React Native projects
MIT License
48 stars 10 forks source link

Needs "How to add plugin to solidarity" docs #23

Open fvonhoven opened 6 years ago

fvonhoven commented 6 years ago

I have no idea how to use this plugin... I got here from:

image

DanielMSchmidt commented 6 years ago

I hate to write +1 comments like this, but I would like to use this to test conditions for detox and I would need to read through the source code to understand how this works. Would be super great to improve the docs a little.

Judging from the commits I would say @GantMan might be a good candidate. If you have no time for this I will try to fill the gaps by understanding the source code soon 😇

horacioh commented 6 years ago

I added a little explanation of how to use this plugin. there's a PR submitted also.

https://github.com/infinitered/solidarity-react-native/pull/24/files

npm i -g solidarity-react-native
# or
yarn add global solidarity-react-native
 # go to your react native project and run:
solidarity snapshot

hope this helps :)

DanielMSchmidt commented 6 years ago

Thank you for your help! Is this really all? I saw some gradle stuff in the plugin, but it wasn't added on my machine, so I assumed I missed some configuration options, do you know more about this?

horacioh commented 6 years ago

maybe i’m wrong, but the goal of this plugin is to check if you have the correct requirements to run a React Native project. There’s no intent in installing anything for you.

this will help you and your team to check if everyone has the correct tools and versions.

I will use this tool in my React Native trainings (I’m a coach). this will help my students to check if their machine is reqdy to run the workshop project excercise.

is this your usecase? cheers!!

DanielMSchmidt commented 6 years ago

Sorry with "wasn't added" I meant that there is no check for that added in the solidarity config when I so snapshot

DanielMSchmidt commented 6 years ago

My use case is having it as a test after running my react native provisioning (https://github.com/danielmschmidt/ansible-role-react-native)

GantMan commented 5 years ago

I'm going to try to work on this a bit.