Getting Started
Remember that the complete setup instructions are found in the Contribution Guide. The following steps are in case you have difficulties following the Contribution Guide.
Setup Tips for Prerequisites
The following steps can help to set up the environment listed in the Contribution guide
For MacOS
- Install Java 8, Go 1.12,
pyenv
and Docker using homebrew.- Check the following tutorial How to install Java 8 on Mac.
Use
pyenv
to install the python versions, 3.7, 3.8.So far, 3.6 is throwing errors.
- Use pip (installed when installing
pyenv
) to installsetuptools
,virtualenv
, and tox. - Clone the apache beam project from https://github.com/apache/beam
using main branch.
- cd into the /beam root project
Execute the following commands:
./gradlew projects
./gradlew tasks
- To make sure Java environment is correctly installed, execute:
./gradlew -p sdks/java/io/cassandra check
./gradlew -p runners/flink check
For Windows
(in construction)
Content
See child pages in the sidebar:
Beam Jira Beginner's Guide
Beam Testing Tools FAQ
Commiters FAQ
Contribution Testing Guide
Eclipse Tips
Git Tips
Go Tips
Gradle Tips
Java Tips
Jenkins Tips
Jira Dashboards
Jira Tips
Multi-language Pipelines Tips
Python Tips
Release
Setup Tips
Using IntelliJ IDE
- (FAQ) Recovering from common IDE errors
- Additional Plugin Integrations
- Build and test a single module
- Finding Help with IntelliJ
- Perform a full build
- Recover from IntelliJ project corruption
- Run a single IT for a particular runner
- Run a single unit test
- Running a single validates runner test
- Set up IntelliJ from scratch