Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.98 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.98 KB
Raw

integreat-app-native

Android and iOS React Native App for Integreat , Malte and Aschaffenburg.

Contents

Project Setup

Make sure to have read and followed the steps in the general README.

  • Run yarn in the terminal to install all dependencies.
  • Take a look at the available scripts. The most important scripts are also available as IntelliJ Run Configurations.

Depending on whether you want to develop for Android, iOS or both the following extra steps are necessary:

Android

  • Install Java JDK, SDK and Runtime (v8 or v11).
  • Install the Android SDK by using the Android plugin in IntelliJ.
  • Install the latest stable SDK Platform and Android SDK Tools in the SDK Manager (Settings > Languages & Frameworks > Android SDK Updater).
  • Install and accept the SDK license in the SDK Manager.
  • [optional] If you want to develop using an emulator, also install the Android Emulator in the Android SDK settings.

iOS

  • Own a Mac or another Apple device.
  • Install XCode.

Note: In order to work with the project in XCode, always open ios/Integreat.xcworkspace.

Additional Configuration

  • Run > Edit Configurations > Defaults > Jest:
    • Set Configuration file to jest.config.json
  • [optional] Install the following plugins:

Running the app

Take a look at the docs for iOS and Android to see how to run the app.

CMS

Testing with the production cms should be avoided!

In development builds, i.e. yarn start, the test cms is used as default.

To switch between production and test cms, press the yellow location marker on the landing page 10 times. On iOS it may be required to close and reopen the app after changing the cms instance.

The cms repository can be found here. There is no up-to-date api documentation but an outdated one can be found here.

Testing CMS Content

To test with content from the cms the testumgebung can be used. If you don't know how to do that, reach out to us.

Hidden Cities

Hidden cities, especially the testumgebung, can be shown by entering the search query wirschaffendas in the city selection.