Skip to content

Commit b914dca

Browse files
committed
Add getting started section in README.
1 parent fd6584a commit b914dca

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# GoGraphKB
2-
A Graph-oriented Knowledge Base written in Go
1+
# go-graphkb
2+
3+
go-graphkb is a Graph-oriented Knowledge Base written in Go.
4+
5+
The knowledge base can then be queried using [openCypher](https://github.com/opencypher/openCypher)
6+
and results can be visualized in the UI as shown below.
7+
8+
![go-graphkb ui](./docs/images/go-graphkb.png)
9+
10+
11+
## Getting started
12+
13+
Run the following commands
14+
15+
# Spin up a mariadb in few seconds with
16+
docker-compose up -d
17+
18+
# Wait a few seconds for the db to be ready before
19+
# inserting the example data available in examples/
20+
# with the following command.
21+
go run cmd/go-graphkb/main.go start
22+
23+
# In another terminal start the web server with the following
24+
# command to acces the web UI at http://127.0.0.1:8090
25+
go run cmd/go-graphkb/main.go listen
26+
27+
28+
## LICENSE
29+
30+
**go-graphkb** is licensed under Apache 2.0.

docs/images/go-graphkb.png

111 KB
Loading

0 commit comments

Comments
 (0)