habits-cli

# Habits CLI > Author: Jimmy Lan In this article, we will go over some high-level details of this repository. > We will explore: > > - [Quick Start](#quick-start) > - [Overview](#overview) > - [Manuals and Logs](#manuals-and-logs) > - [License and Contribution Note](#license-and-contribution-note) > - [Onboard this Project](#onboard-this-project) > - [Useful Commands](#commands) [View this documentation on a website.](https://habits-cli.jimmy-lan.com) ## Quick Start [Using Habits CLI](#using-habits-cli) · [Contributing to Habits CLI](#contributing-to-habits-cli) · [Why Habits CLI?](#overview) ### Using Habits CLI Please view these guides in order: - Installation: [click here to view](overview/installation.md); - Usage Quick Start: [click here to view](overview/usage-quick-start.md); - Other Resources: [Change Logs](change-logs/README.md) · [Demos](demo/README.md) · [Release Plans](release-plans/README.md) · [Testing Manuals](testing/README.md). ### Contributing to Habits CLI Please navigate to the [Onboard this Project](#onboard-this-project) section below. Thank you for your interest in contributing to the Habits CLI! ### Announcements * Habits CLI `v0.2-alpha` release testing is currently in progress and will be concluded by 22:00 on October 4th, 2021 (EDT). * If you encounter an issue during testing, please [open an issue](https://github.com/lanyanxiang/habits-cli/issues). If you wish to stay anonymous, please contact Jimmy ([@lanyanxiang](https://github.com/lanyanxiang)). We will create the tickets for you as a result. Have fun testing! --- ## Overview [View this documentation on a website.](https://habits-cli.jimmy-lan.com) ### Purpose The habits application seeks to help individuals build up healthy habits. ### Background Based on existing psychological research, one feels more motivated when the reward of keeping healthy habits and completing daily tasks is quantified. Further, one's desire to complete a TODO item might become higher when some randomness of rewards is involved. ### The habits app The habits application allows individuals to define custom digital properties. Users may use the application to reward themselves with digital properties whenever they achieve goals, complete tasks, etc. Optionally, the user may also deduct some digital assets whenever they perform bad habits. The user may define the exchange rate between digital properties and real-world items. ### The habits CLI Before I turn this README.md text that you randomly found on GitHub into an academic paper, let's talk about the Habits command-line interface. (Let me assure you, this is not a school project. As we know, I always like to find some weird reasons when I want to code some stuff in my leisure time XD) The Habits CLI allows one to use the Habits app from the command line (isn't this obvious? :D). It is especially useful for developers or people using their command lines who do not want to switch to a browser or pick up their phone. Running simple commands such as `habits transaction add` and `habits property update`, individuals can apply rewards to themselves without leaving their comfortable command line window. The data will be synced across all Habits app clients (e.g., mobile app and web app). ## Manuals and Logs [View this documentation on a website.](https://habits-cli.jimmy-lan.com) **09/06/2021 Update:** Release plan for `v0.2-alpha` has been published! Please see [this page](release-plans/v0.2.md) for more information :D **09/30/2021 Update:** Change logs for `v0.2-alpha` has been published! Please navigate to [this page](change-logs/v0.2.md) for more information. Please refer to the most updated [change logs](change-logs) and [testing manuals](testing) for more information. ## License and Contribution Note [View this documentation on a website.](https://habits-cli.jimmy-lan.com) This repository is released under the GNU General Public License v3.0. Please find more information in the file named `LICENSE` or `LICENSE.md` in the root repository. You are always free to use or modify this code in your own project(s), if applicable, as long as you follow the terms and conditions outlined in the `LICENSE` file described above. It is your responsibility to properly read and understand the terms and conditions from the license file prior to using any part, or parts, of code from this repository. ## Onboard this Project [View this documentation on a website.](https://habits-cli.jimmy-lan.com) If you don't find the set-up process intuitive enough, please have a look at this [setup guide](overview/setup.md). Joining or extending a project may be a challenging experience for some. That's why I aim to provide a good documentation so that you can get up to speed regardless of your prior experience. Please read some more documentation pages in the documentation site if you require further support. ## Commands [View this documentation on a website.](https://habits-cli.jimmy-lan.com) ?> You might need to use the commands below extensively throughout your contribution to this project. Therefore, I strongly encourage you to become familiar with them as soon as possible. ### Set up project ```bash npm install ``` ### Build CLI ```bash npm run build ``` ### Start CLI build ```bash npm start ``` ### Start documentation site ```bash npm run doc ``` Please look at `package.json` for other available scripts.