/sharebibles-lite

A lighter more fluffy sharebibles

Primary LanguageJavaScriptApache License 2.0Apache-2.0

ShareBibles Lite

CircleCI PRs Welcome Code of Conduct License

This is a mobile application to help share the Bible throughout the world.

Android iOS

Get started

  1. To run this app make sure you can run the react-native base app building projects with native code.

    1. brew install node
    2. brew install watchman
    3. brew install npm
    4. npm install -g react-native-cli

  2. Ensure you have yarn installed, i.e. brew install yarn or https://yarnpkg.com/en/docs/install

  3. Install all the dependencies using yarn install

  4. Install the expo cli yarn global add expo-cli

  5. Start the project by running expo start in the project

  6. Create an account on expo.io and sign into the expo app on your device

  7. Using the expo app on your phone see the awesomeness you have created! (Android, take a picture of your QR code and for iOS send yourself a link)

Bonus: If you want to try out a simple change, open the colours.js file, change a few values like black and white then reload the application.

Create a card on the trello board if this does not work for you.

Contributing

We maintain an active backlog of new features and bugs we would love your help with on Trello.

Have a great idea or change you want to share? Awesome. We actively welcome pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.

We have adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Translations

Developers

When adding a new feature that needs translations, ensure you do the following:

  1. Mark the PR using the Needs Translations GitHub label
  2. Run yarn translate to automatically generate translations for the new translations you added to en.json for all the other languages. These translations will be temporary and will be checked by a human later

Translators

When you are asked to check translations please do the following:

  1. Open the translation file for the language you wish to translate/update (assets/i18n/locales)
  2. Open the corresponding translation changelog file (scripts/translations/changelogs)
  3. Go through the list of uncompleted changes (empty boxes) in the translation changelog file and make any corresponding changes to the translation file for each key.
  4. After making a change (Or checked the exisiting translation is OK), ensure that you mark the corresponding key in the changelog as completed by putting a character in the box [y]

Publishing

See Expo Docs on Standalone apps

exp build:android --release-channel prod-v1
exp build:ios --release-channel prod-v1

Please publish to the prod-v1 channel. If you need to change the standalone application please update this message to use the next prod version, i.e. prod-v2. I would highly recommend aligning the releases to the Expo SDK, i.e. prod-v32 for SDK 32.

License

This project is Apache 2.0 Licensed. We also provide an additional patent grant.