CHUMS Checkin

CHUMS Checkin is an Android app companion for the church management software CHUMS. It's for use on self-checkin tablets at churches that prints name labels and parent pickup slips with unique id codes to ensure children are matched with the correct parents. Visit CHUMS.org to learn more.

Preview

Get Involved

🤝 Help Support Us

The only reason this program is free is because of the generous support from users. If you want to support us to keep this free, please head over to ChurchApps or sponsor us on GitHub. Thank you so much!

🏘️ Join the Community

We have a great community for end-users on Facebook. It's a good way to ask questions, get tips and follow new updates. Come join us!

⚠️ Report an Issue

If you discover an issue or have a feature request, simply submit it to our issues log. Don't be shy, that's how the program gets better.

💬 Join us on Slack

If you would like to contribute in any way, head over to our Slack Channel and introduce yourself. We'd love to hear from you.

🏗️ Start Coding

If you'd like to set up the project locally, see our development guide. The short version is:

1. Prerequisite First set follow the setup instructions for CHUMS
2. Install the dependencies with: npm install
3. Configure - Copy dotenv.sample.txt to .env and updated it to point to the appropriate API urls. On env changes please restart the server with npm start -- --reset-cache. For the cases when connecting to local running apis, use system's ip (192.---.-.---) instead of localhost.
4. Start React Native - Run npm start to start the React Native server.
5. Install Android App - In Android Studio open the /android folder and click the run button to install the app on your device. It will initially load with the logo missing, you need to connect it to the ReactNative server.
6. Connect App to React Native - Either shake the device or run adb shell input keyevent 82 to open the developer menu. Go to settings, Debug server host and enter YourIP:8081. Restart the app and it should work properly.

Connect Debugger

To debug within VSCode, set breakpoints like normal, then:

1. Click on the Run and Debug tab on the left of VSCode.
2. Click the Play button with the Attach to packager option
3. From the Metro command prompt window, press the D button to start debugging.
4. The program will now pause at your breakpoints.

Release build

1. Hardcode stage to prod EnvironmentHelper.ts
2. Increment the version number in android/app/build.gradle
3. Update version number in package.json
4. Run npm run build:android to generate a Google Play release
5. Run npm run build:amazon to generate an Amazon release