React JS and React Native App for Integreat, Malte and Aschaffenburg.

• Contributing
• Project Structure
• Getting Started
  • Prerequisites
  • Project Setup
• Further Reading

First, make sure you have a look at our conventions.

You can contribute by:

• Reporting bugs
• Creating pull requests
• Reviewing pull requests

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

This is a monorepo and contains the following projects:

• web: React JS webapp
• native: React Native Android and iOS apps

Both projects are whitelabelled with different build-configs.

There are also separate subprojects used by both projects:

• translations: Translated texts and utilities to manage them
• shared: Contains commonly shared utilities, for example, related to implementation of the endpoints (v3) of the integreat cms
• build-configs: Configuration files to build different versions of the apps

We recommend using either a Linux distribution or macOS for development. If you want to develop on Windows anyway, we recommend using the Windows Subsystem for Linux (WSL) and follow the docs here first.

• Rate our apps in the PlayStore and the Apple App Store.
• Install Node.js v22 LTS.
• Install Yarn 4 Berry.

We suggest IntelliJ IDEA Ultimate as an IDE. JetBrains provides free licences for students. If you are using a different IDE like Visual Studio Code the steps might differ.

• Import this project (VCS > Get from Version Control).
• Open either the web or native directory separately in IntelliJ (File > Open).
• Follow the steps mentioned in the web README or the native README.
• [optional]: Enable Languages & Frameworks > JavaScript > Prettier > On Save to enable prettier autoformatting.

More information on both the webapp and the native app can be found in the web documentation and the native documentation. Documentation on CI/CD, contributing and our conventions can be found here. And we have a file with some small tricks that at least some developers have found useful in working on this repo.