A cross platform application built with Flutter, designed to provide resources for reading, studying the bible, praying, evangelism and missions.
- Onboarding: Non-Christian and Christian onboarding, also the gospel message "The Romans Road" is a placeholder till production realease.
- Home: Features a dashboard.
- Pray: Features to support a prayer life, create and share your prayers.
- Read: Read the KJV Bible, auto scrolling and save your bookmarks or favorite versus.
- Study: Tools and resources for in-depth study of the scriptures using Strong's Greek and Hebrew Numbers, KJV definitions, Websters 1828 dictionary. Every scripture verse can be notated with Notes Manager.
- Go: Content related to the Gospel, and integration of osm map data, for geographical context related to soul winning or missions. Also Offline support with Map Markers to Contact Management.
This project is a Flutter application. To get started:
- Ensure you have Flutter installed. Follow the official guide: Install Flutter
- Clone the repository:
git clone <repository_url>
- Navigate to the project directory:
cd by_faith_app - Get the project dependencies:
flutter pub get
- Run the app on a connected device or emulator:
flutter run
- Onboarding, every user has to onboard and create profile to use the app, once profile is created the onboarding will not appear again. Also no data is collected your data stays on your device. The onboard has a skip button during testing but will be disabled in production.
- Navigation, there are two ways to navigate through the pages with tabs and links in dashboard by clicking the data cards. Also all pages have menu button on top right.
- Maps & Markers, the world map is default online osm map. To use offline maps click menu and press "Select your own map" button and zoom out and move map around until the blue box is in the area you want to select then zoom down until you see street names, then click "Download Map" button. Be careful and look at the download size before clicking download, the further you zoom down the higher the download size. When you add marker it will auto create a new contact that you need to fill out and save before it appears on map.
- Prayers, after creating a new prayer swipe right to change status and swipe left to delete, and to share the prayer it has to be in Unanswered status. Only sharing through Social Media works but atm Offline Export does not.
- Bible Reader, to add bookmarks or favorites click on the verse numbers and for auto scrolling to work turn on in settings first the go back and click full screen mode top left then it will start automatically.
- Bible Study, to add bible notes click on the verse number and it will add the verse to Bible Notes category the click edit to add note, for Study and Peronal notes click the Add Note + top right in Notes. To access the 1828 Websters Dictionary you have to do a word Search that has search results for dictionary and bible.
- Backup & Export, caution there is no data backup option yet during testing so be aware that you can lose your data and have to start over.
#Linux
#Android
Contributions are welcome! Please see the CONTRIBUTING.md (if it exists) for details.
This project is licensed under the MIT License - see the LICENSE file for details.