workwatch/docs/02-installation.md

A Linux terminal program for honest worktime tracking and billing.

# 2. Installation

WorkWatch is being developed and maintained in pure JavaScript and uses pure Node.js APIs. The best way to install and to make it up to date is using the npm provided with the Node.js platform.

> Note: Installation and keeping the Node.js up to date is beyond of this documentation. Check the [Node's website](https://nodejs.org/) for instructions.

To install the program run the following command:

```sh
$ npm install -g workwatch
```

This will install the WorkWatch globally and you'll be able to call the program directly by the `workwatch` command's name. There is no need to install the program locally but if you really want to do it you can skip the `-g` option.

This command can be also used to always install the program's newest version. It is possible to use `npm update` but it depends on some configuration so using `npm install` ensures freshness.

During the installation the data directory and its content is being discovered and checked. If there is no data directory the postinstall script will create one, usually `/home/user/.workwatch`. By default, all scripts' output is suppressed and no message will be visible. You can see the whole process by setting the `freground-scripts=true` in your `.npmrc` file and all postinstall's messages will be printed on your terminal.

If you need to install the program manually you can do so by downloading a packaged version from the GitLab's project [releases page](https://gitlab.com/l0cust/workwatch/-/releases).

You have four different packages to choose: a zip package, tar, tar.gz and tar.bz2. Download the one most fitting and extract it. Run the postinstall script placed in scripts directory which will make all necessary operations for data directory check or creation. Don't forget to add the bin directory to your `$PATH` environment variable for not having to type the full path to the program's executable.