Skip to content

Commit

Permalink
chore(doc): update README to include some instructions about accessin…
Browse files Browse the repository at this point in the history
…g the database and the static data files that have to be occasionally updated
  • Loading branch information
updraft0 committed Jun 28, 2024
1 parent 8432d1a commit 19729ae
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ In the future:
* [ ] Intel information is editable (e.g. system owner) and notes
* [ ] Route calculation
* [ ] Notifications for when systems become connected
* [ ] ZKill feed
* [ ] Thera feed

## Developing

Expand All @@ -64,6 +66,25 @@ to hack on the frontend CSS) on a Unix like system (tested on Linux only but sho
* In a separate terminal tab, run `sbt server/run` (after having brought in all the appropriate environment variables)
* Open up http://localhost:8091/ - you should be able to see the login screen and your maps

The database used is [sqlite] and there are actually three separate databases that are created: `sde.db`, `map.db` and
`auth.db`. Migrations are stored in [db resources](./db/src/main/resources) and you should be able to point any SQL
client at the database files by running:

```sqlite
ATTACH DATABASE 'path-to/map.db' as map;
ATTACH DATABASE 'path-to/sde.db' as sde;
ATTACH DATABASE 'path-to/auth.db' as auth;
```

### Updating static data

There are sources of data that are not included in the [SDE][eve-online-sde]:

* Signatures by group (e.g. Data site names) in [`ref_signature_in_group.csv`](./db/src/main/resources/map/reference/ref_signature_in_group.csv)
* Wormhole statics in [`ref_system_static_wormhole.csv`](./db/src/main/resources/map/reference/ref_system_static_wormhole.csv)

These have to be maintained manually.

## Contributing

If you want to get in touch, report a bug or submit some code changes please either open an issue or start a discussion.
Expand All @@ -77,4 +98,5 @@ A fuller `DEVELOPING.md` guide will probably be available eventually.
[mise]: https://github.com/jdx/mise
[pathfinder]: https://github.com/goryn-clade/pathfinder
[scala-lang]: https://scala-lang.org/
[sqlite]: https://www.sqlite.org/index.html
[vite]: https://vitejs.dev/

0 comments on commit 19729ae

Please # to comment.