add README

remove todo
2021-05-05 21:28:20 +00:00
parent 09e1d643b6
commit e1ad9f0acf
2 changed files with 33 additions and 1 deletions
@@ -0,0 +1,33 @@
+# Elite: Dangerous - Companion
+
+A web based personal companion. It uses a spatial database under the hood to answer questions.
+Ideally before you already know you have them.
+
+## Goals
+
+Its goal should be to know where you are ...
+
+* ... and propose profitable trade routes in the vicinity.
+* ... and what you are carrying and where to sell it for the most profit.
+* ... and which bounties and fines you have and where the nearest Interstellar Factors is.
+
+### Running
+
+1. download https://eddb.io/archive/v6/systems_populated.jsonl to `/home/vscode/systems_populated.jsonl`
+```shell
+# wget --compression=gzip -O /home/vscode/systems_populated.jsonl https://eddb.io/archive/v6/systems_populated.jsonl
+```
+
+2. download https://eddb.io/archive/v6/stations.jsonl to `/home/vscode/stations.jsonl`
+```shell
+# wget --compression=gzip -O /home/vscode/stations.jsonl https://eddb.io/archive/v6/stations.jsonl
+```
+
+3. run backend server
+```shell
+# ./mvnw spring-boot:run
+```
+
+4. run frontend server
+```shell
+```