Skip to content

Commit

Permalink
Merged branch feature/thrive into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
horia141 committed Nov 21, 2024
1 parent a89ac09 commit 4c87e9f
Show file tree
Hide file tree
Showing 68 changed files with 133 additions and 133 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The Jupiter Goal Management System ![Develop](https://github.com/horia141/jupiter/workflows/Develop/badge.svg) ![Release](https://github.com/horia141/jupiter/workflows/Release/badge.svg) [![Documentation Status](https://readthedocs.org/projects/jupiter-goals/badge/?version=stable)](https://jupiter-goals.readthedocs.io/en/stable/?badge=stable) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
# The Thrive Goal Management System ![Develop](https://github.com/horia141/jupiter/workflows/Develop/badge.svg) ![Release](https://github.com/horia141/jupiter/workflows/Release/badge.svg) [![Documentation Status](https://readthedocs.org/projects/jupiter-goals/badge/?version=stable)](https://jupiter-goals.readthedocs.io/en/stable/?badge=stable) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Jupiter is a tool for _life planning_. It provides goals management, task tracking,
Thrive is a tool for _life planning_. It provides goals management, task tracking,
habit building, chores management, lists, metrics, a personal relationship manager, and
much more all in a unified package.

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/accounts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Accounts

The account is the way you indentify yourelf relative to Jupiter. The _unique identifier_
The account is the way you indentify yourelf relative to Thrive. The _unique identifier_
is your email address.

Your account is uniquely linked to your [workspace](./workspaces.md) and this is private
Expand All @@ -10,9 +10,9 @@ You can create an account (and associated workspace) as [shown here](../how-tos/

## Properties

An account has an email. This is your unique identifier you are known by in Jupiter.
An account has an email. This is your unique identifier you are known by in Thrive.

An account has a name. This is simply the name that you want to be known by in Jupiter,
An account has a name. This is simply the name that you want to be known by in Thrive,
but it doesn't carry any other constraints other than being non-empty.

An account also has a timezone. This is the preferred timezone in which you wish to see
Expand Down
18 changes: 9 additions & 9 deletions docs/concepts/clients.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
# Clients

There are multiple ways for interacting with Jupiter.
There are multiple ways for interacting with Thrive.

## The Web App

There is a Jupiter web app that you can [access online](https://jupiter-webui.onrender.com).
There is a Thrive web app that you can [access online](https://jupiter-webui.onrender.com).
It only works in [hosted mode](hosted-vs-local-mode) and will store all the account's and
workspace's data on infrastructure run by the Jupiter organisation. This is the preffered
workspace's data on infrastructure run by the Thrive organisation. This is the preffered
way to use the system, both for ergonomic and ease of access reasons.

## The CLI App

There is a Jupiter CLI app that you can [dowload](../how-tos/install.md). It only works in
There is a Thrive CLI app that you can [dowload](../how-tos/install.md). It only works in
[local mode](hosted-vs-local-mode.md) and will store all the account's and workspace's
data on your local machine. Otherwise all functionality is the same.

You can run

```bash
jupiter --help
thrive --help
```

To get online help from the app.

A typical command interaction might look like:

```bash
jupiter inbox-task-show
jupiter inbox-task-update --id 5 --status done
jupiter gc
jupiter report
thrive inbox-task-show
thrive inbox-task-update --id 5 --status done
thrive gc
thrive report
```
4 changes: 2 additions & 2 deletions docs/concepts/feature-flags.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Feature Flags

Jupiter can be quite overwhealming with its feature set and the various interaction modes between
Thrive can be quite overwhealming with its feature set and the various interaction modes between
each feature. At the same time, not everyone needs everything from the tool. Some might use it
primarily for short term work, others to plan out their life, while still others might focus on
tracking and recording things.

To account for this, the feature set visible for a user in workspace can be configured.
Thus you can customize your Jupiter experience, and keep only the features you need.
Thus you can customize your Thrive experience, and keep only the features you need.
And of course, you can add and remove features at any time.

Indeed, **the backing data is never lost**. If you disable a feature, then all its associated data
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/gamification.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Gamification

Jupiter has a simple notion of [gamification](https://en.wikipedia.org/wiki/Gamification) built in.
Thrive has a simple notion of [gamification](https://en.wikipedia.org/wiki/Gamification) built in.
It is optional though, see below.

The focus is on completing [inbox tasks](inbox-tasks.md) and [big plans](big-plans.md). Every piece of
Expand All @@ -19,7 +19,7 @@ There's also a random "lucky puppy" bonus you get from time to time on successfu
one point.

The points you score add up over time. There's a daily, weekly, monthly, quarterly, yearly and lifetime
total scores that Jupiter tracks.
total scores that Thrive tracks.

You can view the daily and weekly score summary in the Web UI:

Expand Down
8 changes: 4 additions & 4 deletions docs/concepts/hosted-vs-local-mode.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Local Vs Hosted Mode

You can use Jupiter in two primary ways - _hosted_ or _local_.
You can use Thrive in two primary ways - _hosted_ or _local_.

_Hosted mode_ is what you get when you go to [the webapp](https://jupiter-webui.onrender.com/).
The Jupiter company is hosting a central install of the Jupiter software, and manages all the
The Thrive company is hosting a central install of the Thrive software, and manages all the
user accounts, infrastructure, data, etc. to make this happen. Your workspace is in the
_cloud_. Since it's on the web, you can access it from everywhere, and every one of your
devices. This is the simplest and most convenient way to use Jupiter.
devices. This is the simplest and most convenient way to use Thrive.

_Local mode_ is what you get when you [download](../how-tos/install.md) the CLI app and run it on your
own computer. Your workspace lives on your machine, and is not accessible from anywhere else.
Nobody else has access to your data, and you can take control of infrastructure needs yourself.
This is an advanced/niche way of using Jupiter, but I'm committed to making this thing work
This is an advanced/niche way of using Thrive, but I'm committed to making this thing work
well too.
10 changes: 5 additions & 5 deletions docs/concepts/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Intro

Jupiter is a tool for _life planning_. It is _opinionated_ in how it approaches
this problem. The goal of this page is to document Jupiter's conceptual model
Thrive is a tool for _life planning_. It is _opinionated_ in how it approaches
this problem. The goal of this page is to document Thrive's conceptual model
and how life planning is mapped to it.

There will be references made to the current implementation. But the concepts
Expand All @@ -13,7 +13,7 @@ are _separate_ from it, and could just as easily be implemented via pen & paper.

As a quick reference, here is the list of the more important concepts:

* _Workspace_: the _place_ where all the work in Jupiter happens.
* _Workspace_: the _place_ where all the work in Thrive happens.
* _Task_: an atomic unit of work. This is normally something like "Congratulate
Jeff on the speech", or "Buy new socks".
* _Habit_: a regular activity, usually one that is centered on _you_. Think
Expand All @@ -33,12 +33,12 @@ As a quick reference, here is the list of the more important concepts:
* _Person_: a family member, friend, acquaintance, etc you wish to keep in touch with, or
otherwise know about in a more formal way.
* _Push Integrations_: lightweight integrations with external tools such as Slack, GMail,
Outlook, generic email, etc. Done in a one-way fashion via these tools pushing work into Jupiter.
Outlook, generic email, etc. Done in a one-way fashion via these tools pushing work into Thrive.

The rest of the document will cover each of these in greater detail.

## The Tool

Jupiter is _the tool_ that allows you to run your life by using the concepts above in certain ways.
Thrive is _the tool_ that allows you to run your life by using the concepts above in certain ways.

You can interact with it via one of the [clients](clients.md) and in either [hosted or local mode](hosted-vs-local-mode.md)
2 changes: 1 addition & 1 deletion docs/concepts/persons.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The personal relationship manager (PRM) is a database of people with which you w
special contact. It's like a _customer relationship management_ system, but for the people in
your life.

It's first role is simply as a database of the persons you know. But via other Jupiter mechanisms
It's first role is simply as a database of the persons you know. But via other Thrive mechanisms
it can make sure you don't forget about birthdays, or remember to catch up regularly, or even
call for specific holidays.

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/working-mem.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Working Mem

Jupiter has a feature for
Thrive has a feature for
[workingmem.txt](https://calnewport.com/
deep-habits-workingmemory-txt-the-most-important-productivity-tool-youve-never-heard-of/) files.

Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/workspaces.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Workspace

All the work for life planning takes place in a _workspace_. When you create a new
account in the web app or call `jupiter init` in the CLI app you are creating
account in the web app or call `thrive init` in the CLI app you are creating
a new workspace.

Right now, a single account can have just one workspace, that is private to the user.
Expand Down Expand Up @@ -30,7 +30,7 @@ In the Web app you can access workspace settings in the right-hand menu.

In the CLI app you can:

* Create a workspace when creating an account in the web app of via `jupiter init`
* Create a workspace when creating an account in the web app of via `thrive init`
* Set the name via `workspace-update` or editing the name in the web app.
* Change the default project from the `Settings` section of the right-hand side menu or
via `workspace-change-default-project` in the CLI.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-tos/do-garbage-collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,5 @@ item and click "Garbage Collect".
The same thing can be achieved with the `gc` command of the CLI, like so:

```bash
$ jupiter gc
$ thrive gc
```
26 changes: 13 additions & 13 deletions docs/how-tos/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

## Web Application

The simplest way to use Jupiter is by using the [web application](https://jupiter-webui.onrender.com/).
The simplest way to use Thrive is by using the [web application](https://jupiter-webui.onrender.com/).
If this is the first time you're visiting you'll be prompted to create an account.

By using the web application you will be running in [hosted mode](../concepts/hosted-vs-local-mode.md).

## MacOS Dmg Local

For MacOS, a simple way of installing the Jupiter CLI is via a `dmg` archive published
For MacOS, a simple way of installing the Thrive CLI is via a `dmg` archive published
together with a release. You can check them [in the release page](https://github.com/horia141/jupiter/releases).

![Releases](../assets/install-release.png)
Expand All @@ -20,9 +20,9 @@ like any other application.
Invoking this is a bit tricky however:

```bash
$ mkdir my-jupiter-work-dir # A dir where you manage local Jupiter data.
$ cd my-jupiter-work-dir
$ /Applications/Jupiter.app/Contents/MacOS/jupiter init --help
$ mkdir my-thrive-work-dir # A dir where you manage local Thrive data.
$ cd my-thrive-work-dir
$ /Applications/Thrive.app/Contents/MacOS/thrive init --help
```

You can of course add an alias to your shell about it.
Expand All @@ -33,7 +33,7 @@ By using this approach you will be running in [local mode](../concepts/hosted-vs

Another way to install it is from "sources" on GitHub.

You need to make sure you have a recent Python3 installed. Jupiter has been tested on Python 3.10. Docker is also
You need to make sure you have a recent Python3 installed. Thrive has been tested on Python 3.10. Docker is also
useful to have on board.

From GitHub you can just clone the repository like so:
Expand All @@ -44,25 +44,25 @@ $ git clone [email protected]:horia141/jupiter.git jupiter

This will get you the `master` version of the code.

After this, you can build a Docker image with Jupiter like so:
After this, you can build a Docker image with Thrive like so:

```bash
$ cd jupiter
$ cd thrive
$ make docker-build
```

This will chug for a while and produce a local image called `jupiter-cli`. You can use this to run commands like so:
This will chug for a while and produce a local image called `thrive-cli`. You can use this to run commands like so:

```bash
$ mkdir ~/my-jupiter-work-dir # A dir where you manage local Jupiter data.
$ cd ~/my-jupiter-work-dir
$ docker run -it --rm --name jupiter-app -v $(pwd):/data jupiter-cli init --help
$ mkdir ~/my-thrive-work-dir # A dir where you manage local Thrive data.
$ cd ~/my-thrive-work-dir
$ docker run -it --rm --name thrive-app -v $(pwd):/data thrive-cli init --help
```

Alternatively, you can use the scripts locally, like so:

```bash
$ cd jupiter
$ cd thrive
$ mkdir .build-cache
$ ./scripts/setup-for-dev.sh # Hopefully this is simple!
```
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Jupiter
# Thrive

## About

Jupiter is a tool for _life planning_. It provides goals management, task tracking, work planning,
Thrive is a tool for _life planning_. It provides goals management, task tracking, work planning,
habit building, a journal, chores management, lists, metrics, a personal relationship manager, and
much more all in a unified package.

Expand Down Expand Up @@ -30,4 +30,4 @@ And here's one for the "big plans timeline" view:

## Further Reading

Follow the [tutorial](tutorial.md) or [concepts](concepts/overview.md) to get a feeling for what Jupiter can do.
Follow the [tutorial](tutorial.md) or [concepts](concepts/overview.md) to get a feeling for what Thrive can do.
2 changes: 1 addition & 1 deletion docs/releases/version-0.0.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Launched on 2020/03/01.

Checkout [the announcing Jupiter blog](https://dev.to/https://dev.to/horia141/announcing-jupiter-bf3) for the bulk of it
Checkout [the announcing Thrive blog](https://dev.to/https://dev.to/horia141/announcing-jupiter-bf3) for the bulk of it
(for version 0.0.0 if you will).

This version introduces:
Expand Down
4 changes: 2 additions & 2 deletions docs/releases/version-0.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ This version introduces:

* A radical rework of the way interaction between the local space and Notion works. It's only visible in the workspace
and vacations interactions now, but it'll seep into every facet. Basically there will be parity between what can be
done with Notion and what via `jupiter` CLI commands. Editing files will be a thing of the past as well. You can
done with Notion and what via `thrive` CLI commands. Editing files will be a thing of the past as well. You can
checkout the [tutorial](https://github.com/horia141/jupiter/blob/develop/docs/tutorial.md) and
[concepts](https://github.com/horia141/jupiter/blob/develop/docs/concepts.md) for more details. But in short, now
you can do something like `jupiter vacations-add --name "Trip to Spain" --start-date 2020-05-03 --end-date 2020-05
you can do something like `thrive vacations-add --name "Trip to Spain" --start-date 2020-05-03 --end-date 2020-05
-18` and you'll get a new vacation with those coordinates.
* The above is the biggest "feature" in a while, hence the version is bumped from `0.0.5` to `0.1.0` - a minor bump!
* Technically, all scripts now reside in `./scripts`, rather than spread around Makefiles and GitHub actions
2 changes: 1 addition & 1 deletion docs/releases/version-0.10.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Launched on 2022/02/25

Like [version 0.9.0](version-0.9.0.md), this launch includes a numbr of big changes.
They have to do with UX this time and how one interacts with Jupiter via Notion.
They have to do with UX this time and how one interacts with Thrive via Notion.

This version introduces:

Expand Down
2 changes: 1 addition & 1 deletion docs/releases/version-1.0.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ Launched on 2023/06/25

The changes are too numerous to count here. But the major ones are:

* A web app version of Jupiter with a nice GUI and feature parity with the CLI
* A web app version of Thrive with a nice GUI and feature parity with the CLI
* Multi-user support in both the web app and CLI app
* Dropping Notion support
2 changes: 1 addition & 1 deletion docs/roadmap.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Roadmap

Jupiter is now at `v1.0.0`. This means it has some notion of stability and is also shareable and usable by
Thrive is now at `v1.0.0`. This means it has some notion of stability and is also shareable and usable by
folks besides me - its creator. Nevertheless, it is a labour of love and a side-project. It has some way
to go before doing all the things I'd like it to. This doc is a rough roadmap. But there's _no commitment_ to
dates or order of delivery.
Expand Down
4 changes: 2 additions & 2 deletions docs/tools/pomodoro-timer.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Pomodoro Timer

Jupiter offers a basic [Pomodoro timer](https://en.wikipedia.org/wiki/Pomodoro_Technique).
Thrive offers a basic [Pomodoro timer](https://en.wikipedia.org/wiki/Pomodoro_Technique).
You can use it during your work, instead of an external tool.

![Timer](../assets/pomodoro-timer.png)

A CLI command also exists invoked via `jupiter pomodoro`.
A CLI command also exists invoked via `thrive pomodoro`.
4 changes: 2 additions & 2 deletions docs/tools/search.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Search

Jupiter has a generic search functionality. You can use it to quickly jump to
Thrive has a generic search functionality. You can use it to quickly jump to
a given entity.

The webui has a special search page accessible under `Tools`:
Expand All @@ -11,7 +11,7 @@ But you can also invoke quick search at any time:

![Quick Search](../assets/search-quick.png)

A CLI command also exists invoked via `jupiter search`.
A CLI command also exists invoked via `thrive search`.

Both forms offer equivalent functionality, which is:

Expand Down
Loading

0 comments on commit 4c87e9f

Please sign in to comment.