-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merged branch feature/thrive into develop
- Loading branch information
Showing
68 changed files
with
133 additions
and
133 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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). | ||
|
||
 | ||
|
@@ -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. | ||
|
@@ -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: | ||
|
@@ -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! | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
 | ||
|
||
A CLI command also exists invoked via `jupiter pomodoro`. | ||
A CLI command also exists invoked via `thrive pomodoro`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.