mantir / Lernreflex

Learning app for Android and iOS
2 stars 2 forks source link

Lernreflex

Lernreflex is an app for Android an iOS to put learning goals in the center of learning. It is developed with React Native

Get started

Before you get started you need node. Then you need the React Native CLI. Install globally with: npm install -g react-native-cli. And then it's all npm, so just download the code and do npm install. When asked to overwrite files choose no. By default the Android project is generated. If you want to add the iOS-Project do node generate-ios.js and then react-native link.

For further instructions how to run a React Native app, please have a look at their docs. To use the app, a running COMPBASE and a Moodle with the COMPBASE-Plugin is required. The ip or url to the API must be specified in the localip.js (without protocol and port, if you want to make changes there you have to change the code in the initialization in models/Model.js)

Troubleshooting

On Windows npm install may fail in the end with 'Looks like you installed react-native globally', then you need to issue the command react-native link manually.

Generate documentation

The documentation can be generated using: jsdoc . -c conf.json. It is exported to /docs