This is a mobile-app for space-repetition learning.
The app is built using Ionic React. Currently, it includes two types of flash cards: QA(Question & Answer) and MCQ(Multiple Choice Question).
Apple Store
Google Play Store
Report Bug | Feedback for Features
—— Haytham Tang
Description of the algorithm
Ionic: To test the app in your local environment, first follow the ionic set-up to make sure you have installed the packages for ionic and node.js.
Repo: Clone the Repo into your local directory by running
git clone https://github.com/educational-technology-collective/srs-mobile.git
Install Haptics Plugin: Haptis Plugin Provided by Capacitor for physical feedback(shaking effect)
cd srs-mobile
npm install @capacitor/haptics
npx cap sync
Install Auth0 SDK: Used for authentication
cd srs-mobile
npm install @auth0/auth0-react
Install Capacitor Plugins: Used for running auth0
cd srs-mobile
npm install @capacitor/browser @capacitor/app
Install ReactMarkdown Plugin: Used for rendering markdown
cd srs-mobile
npm install react-markdown
Install React Icons: Used for some of the icons
cd srs-mobile
npm install react-icons --save
Install Capacitor Assets: Used for app icon
cd srs-mobile
npm install --save-dev @capacitor/assets
After you have set up the repo in your local directory. Run the following commands to try the app:
cd srs-mobile
ionic serve
It should automatically direct you to a local page on your default browser. You can also copy the link into a browser you like. Then use the developer tool to choose your device you can test on web(iPhone 12 Pro is used for development)
If you want to run the app on Ios/Android Simulators, make sure you have the emulators/devices installed on your computer. Then, run the following commands:
ionic capacitor run [ios/android]
You will be prompted to choose a device.
npx cap open ios
After that, choose a device/ios and run on the simulator. Everytime you make a change to the code. You need to run the following command first before reopening Xcode:
ionic capacitor build ios
(P.S: Android SDK 33 is the latest supported version)
npx cap open android
After that, choose a device/ios and run on the simulator. Everytime you make a change to the code. You need to run the following command first before reopening Xcode:
ionic capacitor build android
Ios: Connect your devices to the computer. Use Xcode to build and run. You will need an Apple ID account and enable Developer Mode on your phone.
Android: After you build your app on Android Studio. Go to Build -> Generate Signed Bundle/APK -> APK. Generate an APK file and install it onto your device.
All cards follow the structure of Think -> Tap -> Swipe
You will be presented with a card (QA / MCQ).
If it's a QA-Card, you will be given a question. You will self-evaluate your knowledge retention about QA-Cards.
If it's an MCQ-Card, you will be given a question with 4 options displayed at the bottom. You will have a tested evaluation(by clicking a choice) and self-evaluation(by swiping).
For a QA-Card, you can tap the QA Card itself to flip and see the question with the answer.
For an MCQ-Card, you can tap the card without selecting any choices to flip and reveal the correct choice. You can also select the choice you think is correct, and the card will highlight the correct choice with green background color and the incorrect one with red background color.
Swipe Down: Indicates that you don't want this card to show up anymore.
-
Swipe Right: Indicates that you know and are positive about this card. -
Swipe Left: Indicates that you don't know and are negative about this card. -
Swipe Up: Indicates that you want one more card of the same concept. -
Swipe Down: Indicates that you don't want this card to show up anymore in future reviews(because the card is poor designed or you know this fairly well).
Yunxuan "Haytham" Tang —— yunxuant@umich.edu