f1sh1918 / integreat-app

React JS and React Native App for Integreat

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

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.

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
• api-client: Implementation of the endpoints (v3) of the integreat cms
• build-configs: Configuration files to build different versions of the apps

If you make changes in these sub-projects, make sure to bump the version in the corresponding package.json and run yarn to make these changes available in both projects.

Getting Started

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.

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 (./docs/vscode.md) 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.

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 app documentation. Documentation on CI/CD, contributing and our conventions can be found here.