Skip to content

Commit

Permalink
Add README files on how to setup the project for both Java and Python…
Browse files Browse the repository at this point in the history
… Katas
  • Loading branch information
henryken committed Jun 14, 2019
1 parent d38a4da commit b406dbc
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 5 deletions.
12 changes: 7 additions & 5 deletions learning/katas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@
under the License.
-->

# Beam Kata
Beam Kata is a set of interactive Beam coding exercises (i.e. code kata) that aids in learning Beam programming hands-on. It is built based on [JetBrains Educational Products](https://www.jetbrains.com/education/).

## Objective
The objective of Beam Kata is to provide a structured hands-on learning experience for people to learn about Beam and its SDK by solving focused mini problems with gradually increasing complexity (e.g. SDK, common transforms, common use-case patterns, common problems like word count, etc).
# Beam Katas
Beam Katas are interactive Beam coding exercises (i.e. [code katas](https://codekata.com/))
that can help you to learn Apache Beam concepts and programming model hands-on.
Built based on [JetBrains Educational Products](https://www.jetbrains.com/education/), Beam Katas
objective is to provide a series of structured hands-on learning experiences for learners
to understand about Apache Beam and its SDKs by solving exercises with gradually increasing
complexity. Beam Katas are available for both Java and Python SDKs.
31 changes: 31 additions & 0 deletions learning/katas/java/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

### How to Setup
Please follow the below steps in order to setup the project properly:
* Using IntelliJ Education (or IntelliJ with EduTools plugin), select "Open" and select this
directory (learning/katas/java)
* "Import Gradle project" when prompted, and configure the Gradle setup
* Wait for Gradle build to finish
* Open "Project Structure" and setup the project SDK (e.g. JDK 8)
* Open the "Project" tool window, and select the "Course" view
* Your project is ready

For further instructions on how the IntelliJ Education works, you can refer
[here](https://www.jetbrains.com/help/education/educator-start-guide.html?section=Java).
32 changes: 32 additions & 0 deletions learning/katas/python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

### How to Setup
Please follow the below steps in order to setup the project properly:
* Using PyCharm Education (or PyCharm with EduTools plugin), select "Create New Project" and select
this directory (learning/katas/python)
* Select your project interpreter (e.g. virtualenv), then click "Create"
* Click "Yes" to create project from existing sources when prompted
* Wait for indexing to finish
* Open "Preferences", search for "Project Interpreter", and select/add accordingly (e.g. virtualenv)
* Open the "Project" tool window, and select the "Course" view
* Your project is ready

For further instructions on how the PyCharm Education works, you can refer
[here](https://www.jetbrains.com/help/education/educator-start-guide.html?section=Python).

0 comments on commit b406dbc

Please sign in to comment.