Skip to content

Commit bde987f

Browse files
committed
docs: add instructions to run pipeline manager from source
Signed-off-by: Lalith Suresh <lalith@feldera.com>
1 parent 7181cd3 commit bde987f

2 files changed

Lines changed: 24 additions & 6 deletions

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ pipelines using Feldera Platform.
6767
* [SQL compiler](sql-to-dbsp-compiler): translates SQL programs into DBSP programs.
6868
* [connectors](crates/adapters/): to stream data in and out of Feldera Platform pipelines.
6969

70-
## Quick start
70+
## Quick start with Docker
7171

7272
First, make sure you have [Docker Compose](https://docs.docker.com/compose/) installed.
7373

@@ -84,6 +84,29 @@ to bring it up. We suggest going through our [demo](https://www.feldera.com/docs
8484

8585
Our [Getting Started](https://www.feldera.com/docs/intro) guide has more detailed instructions on running the demo.
8686

87+
## Running Feldera from sources
88+
89+
To run Feldera from sources, first install all the required
90+
[dependencies](CONTRIBUTING.md). This includes the Rust toolchain, Java (at
91+
least JDK 19), Maven and Typescript.
92+
93+
After that, the first step is to build the SQL compiler:
94+
95+
```
96+
cd sql-to-dbsp-compiler
97+
mvn package -DskipTests
98+
```
99+
100+
Next, from the repository root, run the pipeline-manager:
101+
102+
```
103+
cargo run --bin=pipeline-manager --features pg-embed
104+
```
105+
106+
As with the Docker instructions above, you can now visit
107+
[http://localhost:8080](http://localhost:8080) on your browser to see the
108+
Feldera WebConsole.
109+
87110
## Documentation
88111

89112
To learn more about Feldera Platform, we recommend going through the

docs/intro.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@ in a configuration suitable for demos, development, and testing. For production
55
use, or for developing parts of Feldera Platform itself, Feldera Platform
66
supports other forms of deployment.
77

8-
These instructions explain how to run the Feldera Platform on a single machine
9-
in a configuration suitable for demos, development, and testing. For production
10-
use, or for developing parts of Feldera Platform itself, Feldera Platform
11-
supports other forms of deployment.
12-
138
## Install prerequisites
149

1510
To run the demo, you will first need to install Docker and the Docker

0 commit comments

Comments
 (0)