Vsein/Neohabit — Gitpedia

<a names="neohabit" /> <h1 align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="frontend/src/logos/neohabit-header-readme-dark.svg" width="1000px" /> <img src="frontend/src/logos/neohabit-header-readme-light.svg" width="1000px" alt="Neohabit logo" /> </picture> </h1> <a href="#installation">Install</a> • <a href="#features">Features</a> • <a href="https://neohabit.org/projects">Demo</a> • <a href="https://github.com/Vsein/Neohabit/discussions">Discuss</a> • <a href="#donations">Donations</a> A highly customizable habit-tracker that is wired for systematic self-improvement <div align="center"> <a href="frontend/src/assets/neohabit-readme-overview-dark.png" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="frontend/src/assets/neohabit-readme-overview-dark.png" /> <img src="frontend/src/assets/neohabit-readme-overview-light.png" /> </picture> </a> zoomed out overview for 6 months </div>

Features

Habits that happen any amount of times in any amount of days
Intutive design for habits that happen more than once a day
Ability to set targets, and change them on the go
Tracking numeric values (up to 2 billion) and setting numeric targets

You can see the features explained with examples on the
landing. And you can also check out the demo version.

Custom heatmaps, with all the above features

Monochromatic (github/anki-style)

Numeric

Fractured

Designed specifically to track habits that have to happen many times per period
(available up to 16, then defaults to numeric):

Or track habits that happen once in a blue moon:

Combine habits into projects

All displayed in a 1-dimensional mode, which is more suitable for day-to-day tracking:

Skilltrees

Excellent for planning and tracking progressions:

Other things you might find useful

Keybindings for common actions
Two themes available: light and dark
Desktop-focused
Polished mobile interface (browser-only, no app)
Multiple accounts support
Drag and drop projects or habits to rearrange their order
Tooltips with the selected period's information (available when you hover on cells)
Habit and project names are clickable and lead to their individual pages (all links
also available in the sidebar)

Installation

Currently, there are three methods available:

<details> <summary>Docker compose with pre-built images (recommended)</summary>

First, make a directory for docker-compose's configs, then copy
docker-compose.yaml, .env and Caddyfile from this repo:

bash
wget -O docker-compose.yaml https://raw.githubusercontent.com/Vsein/Neohabit/refs/heads/main/docker-compose.yaml &&
wget -O .env https://raw.githubusercontent.com/Vsein/Neohabit/refs/heads/main/.env.example &&
wget -O Caddyfile https://raw.githubusercontent.com/Vsein/Neohabit/refs/heads/main/Caddyfile

Then, edit as desired:

.env to change the db/backend settings, and in-app settings like login behavior
docker-compose.yaml to configure the reverse proxy ports, volumes, and other docker stuff
Caddyfile to adjust the host:
- :80 for LAN or localhost
- :443 for LAN+HTTPS (also uncomment the tls internal and frontend's
  reverse proxy)
- example.com for web-hosting

When ready, run:

bash
docker compose up -d

In ~15 seconds, head to http://127.0.0.1:8080 (default) and check if
everything's up and running.

If you encounter any issues, you can check the logs by running:

bash
docker compose logs

<hr> </details> <details> <summary>Docker compose and building images from source</summary>

If you've chosen this step because I previously recommended to use it for
web-hosting in v1.0.0, that's no longer the case and you can use the first
method instead

Clone this repo and change to the cloned directory:

bash
git clone https://github.com/Vsein/Neohabit.git && cd Neohabit

Copy .env.example into .env

bash
cp .env.example .env

After that, edit the following files as desired:

.env to change the db/backend settings, and in-app settings like login behavior
docker-compose.yaml to configure the reverse proxy ports, volumes, and to
uncomment lines for building manually
Caddyfile to adjust the host:
- :80 for LAN or localhost
- :443 for LAN+HTTPS (also uncomment the tls internal and frontend's
  reverse proxy)
- example.com for web-hosting

When ready, run:

bash
docker compose up -d

In ~30 seconds, head to http://127.0.0.1:8080 (default) and check if
everything's up and running.

If you encounter any issues, you can check the logs by running:

bash
docker compose logs

Also, alternatively to simple docker compose up -d, you can force to rebuild everything:

docker compose up --build --force-recreate

<hr> </details> <details> <summary>Build and serve everything manually</summary>

Requirements:

go
postgresql
npm
python or nginx (for serving the static files)

Setting up frontend

Change into the frontend directory and install dependencies:

bash
cd frontend && npm ci

Build static files:
```
bash
npm run build
```
Serve the static files in /dist, for example with python:
```
bash
python -m http.server 8080
```
Or, run in development mode:
```
bash
npm start
```

Setting up backend

Change into the backend directory and install go packages

bash
go mod download

Create a new Postgres database:

bash
createdb neohabit_database

And modify the env vars before finally running:

bash
JWT_SECRET="SuperSecretInformation" \
PG_DSN="postgres://user:password@localhost:5432/neohabit_database?sslmode=disable" \
go run core/cmd/main.go -config core/config/config.yaml

By default, reverse proxies are set up with Caddy. If you prefer a different web
server, here's a sample nginx.conf
that was used previously. If you've set up the reverse proxy through Traefik,
HAProxy or anything else - feel free to propose a sample snippet, so that it can
be copy-pasted by others in the future for ease of use.

Upgrading

Ultimate vision

My ultimate vision for Neohabit is to have a public, community-driven archive of
habits that may be imported into your database/account, with all the needed
progressions. Somewhat similar to the Anki's shared decks, except for habits.
I've implemented the core feature - the habit-tracking part, but the rest of it
still needs some time to come together.

For example:

There's the tasklist section that I want to integrate with habits, so you can
see which habits are due today (currently the tasks are dangling in their own
section, and weren't my development focus)
The skilltrees are implemented, but right now there's no way to start habits
directly based on the skills listed in the skilltree. I may even take
skilltrees as the base for importing new habits, I guess it'll be more clear
in the future.
"The blocks" page is dangling as a section in the side menu, but I think it'll
just be a link to a website with all the archived skilltrees/habits.
Contribution guides and community support/groups

License

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0).

The AGPL-3.0 applies to the entire repository, including all historical commits.
Any modified versions - especially when offered as a network service or SaaS -
must comply with its copyleft terms.

This license is chosen specifically so that Neohabit remains open-source
forever.

Donations

BTC: bc1qkt9xge2a8h3zt65ju7qkyvh6z6qjn6kdz8tm4a

XMR: 48F86e1vigUU8jUSf3kBYNJhMGp38dKxqBhga9sLz1Lr5qM8QqXrY3g4X8uQyqh7wQKhm7MpxSsSpdp1PGvY96jh1MGwyx8

To anyone who's kind enough to donate, thank you! Neohabit's development has
cost me more than I'm comfortable admitting, if not financially then just in time
alone. Spreading the word and mentioning this project to your friends is also
welcome and much appreciated.