https://github.com/lacunaverse/hawk

get a bird's eye view of you
https://github.com/lacunaverse/hawk

lunar quantified-self

Last synced: 3 months ago
JSON representation

get a bird's eye view of you

• Host: GitHub
• URL: https://github.com/lacunaverse/hawk
• Owner: lacunaverse
• License: gpl-3.0
• Created: 2020-07-30T20:58:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T05:47:45.000Z (about 2 years ago)
• Last Synced: 2024-02-15T03:15:54.433Z (12 months ago)
• Topics: lunar, quantified-self
• Language: TypeScript
• Homepage:
• Size: 1000 KB
• Stars: 3
• Watchers: 0
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• project-awesome - lacunaverse/hawk - get a bird's eye view of you (TypeScript)

README

        
# hawk

`get a bird's eye view of you`

a tool for [quantified-self](https://en.wikipedia.org/wiki/Quantified_self)

Hawk is a tool to log data about yourself and make informed decisions off of it.

## Roadmap

+ API

+ exporting data

+ viewing data

  + pretty-printed dates rather than unix time

  + data diffing (variance between intervals)

  + comparisons, ranges

+ combine into single binary

## Setup

### Development

Requirements:

+ [npm](https://www.npmjs.com/)

+ [go](https://golang.org/)

Running:

`go run .`

## Terminology

### Logs

Logs are an instance of a metric. They describe a single datapoint in a category (metric). For instance:

+ how far did I run on 2020.10.09?

+ how long did I sleep on 2020.10.09?

Together, logs form collections of data which can be used to create inferences and goals.

### Metrics

Metrics are a statistic, to describe a category to log. For instance:

+ weight

+ distance ran

+ minutes slept

They have three criteria:

+ a name, to describe the metric

+ a type, to represent acceptable values for the metric

  + can be a true/false value, number, or text

+ a frequency, to determine how often a metric should be logged (daily, monthly, etc.)

+ optionally, a validator (regex)

## API

## Credits

+ [Heroicons](https://heroicons.dev/)