This repository has been migrated to integreat-app

versioning:

integreat-webapp

Contents

• Contributing
• Getting Started
• Conventions
• Technology Stack
• Browser Stack
• Delivery
• CI/CD
• I18N
• Glossary

Contributing

You can contribute by:

• Creating Pull requests
• Reporting bugs

Testing with the live cms instance should be avoided. Instead, please use the test cms.

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

Prerequisites

• Rate our Integreat app in the PlayStore and the Apple App Store.
• Install nodejs. At least v6 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, the steps might differ.

• 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 a local webpack dev server.
• Start coding :)

Additional Configuration

• Mark the src and www folder as Source directory.

• Run > Edit Configurations > Defaults > Jest and 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
  • EJS

• [optional] Configure Linux environment on Windows: WSL Setup

Trouble shooting

• Use nodejs 12 LTS instead of the latest version.

Bug reporting

You can view our issues or create new ones on our jira.

Pull requests

Please take a look at our conventions.

To merge a pull request,

• at least two approvals are required.
• tests, linting and flow have to succeed.