This repository has been migrated to integreat-app

integreat-react-native-app

Contents

• Contributing
• Getting Started
• Conventions
• Technical Documentation
• Build configs
• Manual builds
• Continuous Integration and Delivery
• Glossary

Contributing

You can contribute by:

• creating pull requests
• reporting bugs

If you want to know more about Integreat or if you want to join us, contact Max, Steffen or our info mail and visit our website.

Getting Started

We suggest IntelliJ IDEA Ultimate as IDE for editing JavaScript code. JetBrains provides free licences for students. If you are using a different IDE, the steps might differ.

Note: For the setup of the project on Windows you may want to use Chocolatey and follow this guide.

Prerequisites

• Rate our Integreat app in the PlayStore and the Apple App Store.
• Install nodejs. At least v10 is required, but we recommend the v12 LTS. Using the latest version (v13) may lead to errors.
• Install yarn.

Android

• Install the Android SDK by using the Android Support plugin in IntelliJ.
• Install the latest stable SDK Platform and Android SDK Tools in the SDK Manager (Settings > Appearance & Behaviour > System Settings > Android SDK)
• [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 XCode project, always open ios/Integreat.xcworkspace.

Project setup

If using IntelliJ IDEA Ultimate you can import the project easily:

• Import this project (VCS > Get from Version Control).
• Run yarn in the terminal to install all dependencies.
• Take a look at package.json to show all available npm scripts.
• Run yarn start to start the bundler.

Note: For editing native Java code for Android IntelliJ with the Android extension is recommended. For native Swift/Objective-C code XCode is required.

Running the app

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

Additional Configuration

• Mark the src folder as Source directory.

• Run > Edit Configurations > Defaults > Jest to set Configuration file to jest.config.json

• Settings > Languages & Frameworks > JavaScript and

  • choose Flow as Language version
  • set Flow package or executable to <project_dir>/node_modules/flow-bin

• [optional] Associate the *.snap files with the file type JavaScript.

• [optional] Install the following plugins:

  • Styled Components
  • Ruby (if working with Fastlane)

Troubleshooting

If you encounter any problems, have a look at our troubleshooting section.

Debugging

For more information on how to debug, have a look at our debugging section.