Skip to content

Commit e35ebbe

Browse files
davidheryantodavidheryanto
committed
Add README to get started for Feast core developers
1 parent ca84197 commit e35ebbe

File tree

3 files changed

+67
-47
lines changed

3 files changed

+67
-47
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
### Scratch files ###
22
scratch*
33

4+
### Feast UI deprecated folder ####
5+
ui/
6+
47
### Local Environment ###
58
*local*.env
69

‎core/README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
### Getting Started for Feast Core Developers
2+
3+
Pre-requisites:
4+
- A running Postgres instance. For easier to get started, please configure the database like so:
5+
```
6+
database: postgres
7+
user: postgres
8+
password: password
9+
```
10+
- A running Redis instance
11+
```
12+
host: localhost
13+
port: 6379
14+
```
15+
16+
Run the following maven command to start Feast core GRPC service running on port 6565 locally:
17+
```bash
18+
mvn spring-boot:run -Dspring-boot.run.arguments=--feast.jobs.workspace=/tmp/feast-jobs-workspace
19+
```
20+
21+
If you have [grpc_cli](https://github.com/grpc/grpc/blob/master/doc/command_line_tool.md) installed, you can test that Feast Core is started properly:
22+
```
23+
grpc_cli ls localhost:6565
24+
grpc_cli call localhost:6565 GetFeastCoreVersion ""
25+
grpc_cli call localhost:6565 GetStores ""
26+
```

‎core/pom.xml‎

Lines changed: 38 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -75,53 +75,44 @@
7575
<groupId>org.xolstice.maven.plugins</groupId>
7676
<artifactId>protobuf-maven-plugin</artifactId>
7777
</plugin>
78-
<plugin>
79-
<groupId>com.github.eirslett</groupId>
80-
<artifactId>frontend-maven-plugin</artifactId>
81-
<version>1.6</version>
82-
<executions>
83-
<execution>
84-
<id>install node and yarn</id>
85-
<goals>
86-
<goal>install-node-and-yarn</goal>
87-
</goals>
88-
<phase>generate-resources</phase>
89-
</execution>
90-
<execution>
91-
<id>yarn install</id>
92-
<goals>
93-
<goal>yarn</goal>
94-
</goals>
95-
<configuration>
96-
<arguments>install</arguments>
97-
</configuration>
98-
</execution>
99-
<execution>
100-
<id>build</id>
101-
<goals>
102-
<goal>yarn</goal>
103-
</goals>
104-
<configuration>
105-
<arguments>run build</arguments>
106-
</configuration>
107-
</execution>
108-
</executions>
109-
<configuration>
110-
<nodeVersion>v10.15.3</nodeVersion>
111-
<yarnVersion>v1.16.0</yarnVersion>
112-
<workingDirectory>../ui</workingDirectory>
113-
<installDirectory>target</installDirectory>
114-
</configuration>
115-
</plugin>
116-
<!-- This plugin is useful for development where developers can start Core with mvn exec:java command -->
117-
<plugin>
118-
<groupId>org.codehaus.mojo</groupId>
119-
<artifactId>exec-maven-plugin</artifactId>
120-
<version>1.6.0</version>
121-
<configuration>
122-
<mainClass>feast.core.CoreApplication</mainClass>
123-
</configuration>
124-
</plugin>
78+
<!-- <plugin>-->
79+
<!-- <groupId>com.github.eirslett</groupId>-->
80+
<!-- <artifactId>frontend-maven-plugin</artifactId>-->
81+
<!-- <version>1.6</version>-->
82+
<!-- <executions>-->
83+
<!-- <execution>-->
84+
<!-- <id>install node and yarn</id>-->
85+
<!-- <goals>-->
86+
<!-- <goal>install-node-and-yarn</goal>-->
87+
<!-- </goals>-->
88+
<!-- <phase>generate-resources</phase>-->
89+
<!-- </execution>-->
90+
<!-- <execution>-->
91+
<!-- <id>yarn install</id>-->
92+
<!-- <goals>-->
93+
<!-- <goal>yarn</goal>-->
94+
<!-- </goals>-->
95+
<!-- <configuration>-->
96+
<!-- <arguments>install</arguments>-->
97+
<!-- </configuration>-->
98+
<!-- </execution>-->
99+
<!-- <execution>-->
100+
<!-- <id>build</id>-->
101+
<!-- <goals>-->
102+
<!-- <goal>yarn</goal>-->
103+
<!-- </goals>-->
104+
<!-- <configuration>-->
105+
<!-- <arguments>run build</arguments>-->
106+
<!-- </configuration>-->
107+
<!-- </execution>-->
108+
<!-- </executions>-->
109+
<!-- <configuration>-->
110+
<!-- <nodeVersion>v10.15.3</nodeVersion>-->
111+
<!-- <yarnVersion>v1.16.0</yarnVersion>-->
112+
<!-- <workingDirectory>../ui</workingDirectory>-->
113+
<!-- <installDirectory>target</installDirectory>-->
114+
<!-- </configuration>-->
115+
<!-- </plugin>-->
125116
</plugins>
126117
</build>
127118

0 commit comments

Comments
 (0)