https://github.com/adapt-it/keyit

Key It
https://github.com/adapt-it/keyit

Last synced: about 6 hours ago
JSON representation

Key It

• Host: GitHub
• URL: https://github.com/adapt-it/keyit
• Owner: adapt-it
• License: mit
• Created: 2021-10-11T23:47:05.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-06T04:07:10.000Z (13 days ago)
• Last Synced: 2024-11-06T04:30:58.394Z (13 days ago)
• Language: Makefile
• Size: 23.9 MB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
### What is this repository for? ###

* Development of Key It as

* 

  an iOS Storyboard app (referred to in this documentation as kitios) and as

  

  an Android app (referred to in this documentation as kitand) and as

  

  an iOS SwiftUI app (referred to in this documentation as kitsui)

### How do I get set up for iOS Storyboard? ###

* Get Xcode 12 or later

* Use Xcode's Source Control to clone the repo from Github, and open the Xcode project

* The SQLite database that is included in recent iOS systems is used. The Xcode project

  includes settings to use the bridge from Swift to C for source code that calls the

  C API of SQLite.

### How do I get set up for Android? ###

* Get Android Studio Arctic Fox or later

* Use Android Studio's Git menu to clone the repo from Github, and open the file build.gradle

* The SQLite database that is included in recent Android systems is used. The kitand sources

  use Android's SQLiteOpenHelper and its API to deal with the SQLite database.

### How do I get set up for iOS SwiftUI? ###

* Get Xcode 15.1 or later

* Use Xcode's Source Control to clone the repo from Github, and open the Xcode project

* The SQLite database that is included in recent iOS systems is used. The Xcode project

  includes settings to use the bridge from Swift to C for source code that calls the

  C API of SQLite.

### Contribution guidelines ###

* On iOS all interaction with SQLite is kept inside the file KITDAO.swift - the rest of the

  code is straight Swift code or, in the case of kitsui, Swift and SwiftUI code.

  On Android all interaction with SQLite is kept inside the file KITDAO.kt - the rest of the

  code is straight Kotlin code.

* Comments about the software design are contained in comments in the source code.

* There are three design documents that describe and give some details of the app design:

	KIT Design Document.odt

	

	KIT Design Document Popovers.ods

	

	KITSUI Model.pdf

### Whom do I talk to? ###

* Developer of this Github repo is Graeme Costin - [email protected].

* This app will be released as an open source freeware app provided by Wycliffe Bible Translators.