Skip to content
Permalink
Browse files
[BAHIR-36] Update Readme.md
- Add how to build and test project

Closes #12
  • Loading branch information
lresende committed Jul 23, 2016
1 parent 61f5592 commit 48e91fca54f7fab6f6171be4c05747a985876483
Showing 1 changed file with 38 additions and 6 deletions.
@@ -1,14 +1,18 @@
# Bahir Repository
# Apache Bahir

Initial Bahir repository (see issue [BAHIR-1](https://issues.apache.org/jira/browse/BAHIR-1)) containing the source for the Spark streaming connectors for akka, mqtt, twitter, zeromq
Apache Bahir provides extensions to distributed analytics platforms such as Apache Spark.

<http://bahir.apache.org/>

## Apache Bahir origins

The Initial Bahir source code (see issue [BAHIR-1](https://issues.apache.org/jira/browse/BAHIR-1)) containing the source for the Apache Spark streaming connectors for akka, mqtt, twitter, zeromq
extracted from [Apache Spark revision 8301fad](https://github.com/apache/spark/tree/8301fadd8d269da11e72870b7a889596e3337839)
(before the [deletion of the streaming connectors akka, mqtt, twitter, zeromq](https://issues.apache.org/jira/browse/SPARK-13843)).

This repo still needs license files, build scripts, READMEs, etc but it does have all of
the commit history as well as the respective examples (with rewritten revision trees to preserve pre-Bahir history).
## Source Code Structure


Folder structure:
Source code folder structure:
```
- streaming-akka
- examples/src/main/...
@@ -19,3 +23,31 @@ Folder structure:
- python
- ...
```

## Building Bahir

Bahir is built using [Apache Maven](http://maven.apache.org/).
To build Bahir and its example programs, run:

mvn -DskipTests clean install

## Running Tests

Testing first requires [building Bahir](#building-bahir). Once Bahir is built, tests
can be run using:

mvn test

## Example Programs

Each extension currently available in Apache Bahir has an example application located under the "examples" folder.


## Online Documentation

Coming Soon.


## A Note About Apache Spark Integration

Coming soon.

0 comments on commit 48e91fc

Please sign in to comment.