Skip to content

Commit 05e87fc

Browse files
committed
chore: etlp-mapper setup docs
1 parent b1c1ce1 commit 05e87fc

File tree

1 file changed

+48
-6
lines changed

1 file changed

+48
-6
lines changed

README.md

+48-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,39 @@
11
# etlp-mapper
22

3-
FIXME: description
3+
Etlp-mapper is a microservice that allows users to create jute based low code data transformation logic.
4+
This service can be used as a standalone Jute based data transformation utility, however, this service forms a crucial component of the `etl` based smart data connectors.
45

5-
## Developing
66

7-
### Setup
7+
## Setup
8+
9+
10+
### Production Build
11+
12+
As a precursor you would need Leiningen, Clojure and Java installed on our machine, once we have the basic runtime up an running, we need to clone this repo and build an uberjar.
13+
14+
15+
```sh
16+
$ lein deps
17+
$ lein uberjar
18+
19+
```
20+
21+
#### Run Migrations
22+
23+
This service depends on Postgres >= v14.00, after successful java jar build, we need to run the migrations to create basic set of tables for our microservice. Once the migrations are successfully applied, we can simply run our jar and it should start the web server at `localhost:3000`
24+
25+
26+
```sh
27+
28+
$ java -jar target/etlp-mapper-0.1.0-SNAPSHOT-standalone.jar :duct/migrator
29+
30+
$ java -jar target/etlp-mapper-0.1.0-SNAPSHOT-standalone.jar
31+
32+
```
33+
34+
35+
36+
### REPL based Interactive Development
837

938
When you first clone this repository, run:
1039

@@ -38,7 +67,7 @@ dev=> (go)
3867
:initiated
3968
```
4069

41-
By default this creates a web server at <http://localhost:3000>.
70+
By default this creates a web server at <http://localhost:3031>.
4271

4372
When you make changes to your source files, use `reset` to reload any
4473
modified files and reset the server.
@@ -65,6 +94,19 @@ But you can also run tests through Leiningen.
6594
lein test
6695
```
6796

68-
## Legal
97+
### Bugs
98+
99+
## License
100+
101+
Copyright © 2024 Rahul Gaur
102+
103+
This program and the accompanying materials are made available under the
104+
terms of the Eclipse Public License 2.0 which is available at
105+
http://www.eclipse.org/legal/epl-2.0.
69106

70-
Copyright © 2023 FIXME
107+
This Source Code may also be made available under the following Secondary
108+
Licenses when the conditions for such availability set forth in the Eclipse
109+
Public License, v. 2.0 are satisfied: GNU General Public License as published by
110+
the Free Software Foundation, either version 2 of the License, or (at your
111+
option) any later version, with the GNU Classpath Exception which is available
112+
at https://www.gnu.org/software/classpath/license.html.

0 commit comments

Comments
 (0)