Skip to content

A caving database interface written in Go.

License

Notifications You must be signed in to change notification settings

IdlePhysicist/cave-logger

Repository files navigation

Cave Logger

Summary

Cave Logger is a basic SQLite database interface written in Go, and it allows cavers to track the caves that they have been to, who with, and when.

I indend to make the code more generic to allow other outdoorsy people to use this app with less fuss.

What It Looks Like

Getting started

Install

You can install by the following set of instructions:

  1. Clone or download the repo, and naviagte to the repo directory
  2. Compile the binary
    • make darwin on a mac
    • make linux on linux
  3. Assuming the binary has built correctly then you have two courses of action:
    • A. If you have no data to import from another media (or wish to manually insert your data) then simply run ./scripts/make-db.py and this will create a correctly formatted sqlite database and a config file
    • B. If you do wish to import existing records then I have a Python script under ./scripts/csv2sqlite.py that you can modify to your purposes. Note this script will create the database for itself.
  4. Finally run make install.
  5. You will now (provided you have a GOPATH set up) be able to run the application by running cave-logger in your shell.

Docker

To run in docker:

  1. Clone or download the repo, and naviagte to the repo directory
  2. Follow step 3 from above
  3. ./run-in-docker

Help

Keybindings

Key Function
q quit
n new
u update
d delete
j down
k up
g end
G home
Tab see menu
Enter inspect record

Menu

In the Menu the Tab key will select the highlighted item, and hitting Tab again will navigate to the Menu.