https://github.com/viveknathani/kkrh

A service to track you, with your control. 🚪
https://github.com/viveknathani/kkrh

golang heroku postgresql redis webapp

Last synced: 1 day ago
JSON representation

A service to track you, with your control. 🚪

• Host: GitHub
• URL: https://github.com/viveknathani/kkrh
• Owner: viveknathani
• License: mit
• Created: 2022-01-03T12:46:21.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-21T19:29:46.000Z (almost 3 years ago)
• Last Synced: 2024-06-20T01:51:20.001Z (5 months ago)
• Topics: golang, heroku, postgresql, redis, webapp
• Language: Go
• Homepage: https://kkrh.herokuapp.com
• Size: 420 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kkrh

kkrh is a web application for tracking my activities. I use it in my daily life to understand my habits better and get insights out of them. Hence the name is an abbreviation of the Hindi sentence "kya kar raha hai".

## why not just use something that already exists?

- I want control over my data. The logs stored in tracking apps describe a lot about the users.

- I get to choose and find the statistics I care about and not be limited to what an application provides.

- It is fun to spin up your own web application.

## tech

- Go

- PostgreSQL

- Redis

## source description

- [cache](./cache): provides an API to work with the cache 

- [database](./database): provides an API to work with the database 

- [entity](./entity): provides the `struct` to represent the entities in the system 

- [repository](./repository): provides the interface implemented by `database` package. 

- [scripts](./scripts): for things like setting up PostgreSQL one time

- [server](./server): provides the HTTP API with some handy middleware

- [service](./service): the core logic of this system, to be used by `server`

- [shared](./shared): for things like managing `context` across `server` and `service` 

- [web](./web): the frontend. 

## what is the framework for frontend?

I chose to write it in vanilla javascript this time. Something like React was not a necessity here and writing in vanilla javascript is fun. 

## kkrh-meta

`kkrh` outputs some logs to `stdout` and `stderr`. I wanted to capture and process them which is why I wrote [kkrh-meta](https://github.com/viveknathani/kkrh-meta/).

## cannot create an account?

- I have disabled the signup functionality for now. This service exists for my own usage with limited use of cloud resources. But you are free to host your own version of kkrh.

## host your own version

- clone this repository.

- create a new app in Heroku with the PostgreSQL addon.

- setup a new Redis server from [here](https://app.redislabs.com/).

- setup the environment variables in Heroku as per the [.env.example](./.env.example) file.

- push the repository to heroku.

- have fun.

## contributing

- `make build`, `make test`, and `make run` will be some handy commands for you. 

- It would be cool if you write an issue before working on a PR. 

## license

[MIT](./LICENSE)