Rock-Native
Rock RMS is an open source Relationship Management System (RMS) and Application Framework. While Rock specializes in serving the unique needs of churches it's useful in a wide range of service industries. Rock-Native is the native runtime for Rock to run on iOS, Android, Windows, tvOS, and web using technologies including react-native, webpack, apollo, and more.
Our main developer starting point site is the wiki.
Learn More
Jump over to the Rock website to find out more. Keep up to date by:
- Reading the Rock blog
- Following RockRMS on Twitter
- Liking RockRMS on Facebook
- Reading the Rock Community Q & A
Installing
- Clone the project.
- Run
yarnto install project dependencies. - If you haven't run a react native project in the past, you may need to do additional setup to run the project in a simulator.
- For setup instructions, go here.
Running Locally
Android
Mac Users: If you are trying to run an android emulator and the emulator will not start, make sure you are not running Docker for Mac. They don't seem to like each other.
- You must first be running a virtual device (or actual device connected to Android Studio) before attempting to start the project. See above instructions if you don't have a virtual device set up.
- Run
yarn androidto start the app on the device.
iOS
- Run
yarn ios
tvOS
- Open the xcode project under
ios/. - Make sure a tvOS simulator is installed in
Preferences > Components. - To run on a tvOS simulator, click
rockNativeon the top bar next to the play and stop buttons. - Choose rockNative-tvOS as your target, and choose an appropriate simulator.
- Click play in XCode.
Web
- Run
yarn web
Contributing
For more information about contributing PRs and issues, see our Contribution Guidelines.
Good First PR is a great starting point for people new to this project.
License
By contributing to Rock-Native, you agree that your contributions will be licensed under our NewSpring Church Community License Agreement.