README.md

integreat-app

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

Contents

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

Contributing

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 Leandra, Steffen or our info mail and visit our website.

Project Structure

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 sub-projects used by both projects:

• translations: Translated texts and utilities to manage them
• shared: Contains common 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

Getting Started

Prerequisites

• Rate our apps in the PlayStore and the Apple App Store.
• Install nodejs v20 LTS.
• Install classic yarn.

Project setup

We suggest IntelliJ IDEA Ultimate as 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.

We are recommending to use either a Linux distribution or MacOS for development. If you want to develop on Windows anyway, follow the steps here or use the Windows Subsystem for Linux following the information here.

Further Reading

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.