Skip to content

Commit

Permalink
Update readme with install and config direction
Browse files Browse the repository at this point in the history
  • Loading branch information
RadhiFadlillah committed Mar 22, 2020
1 parent 09d2140 commit d4058d9
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,47 @@ Duit is a simple money tracker written in Go language and Mithril.js. I created

![Mobile responsive](https://raw.githubusercontent.com/RadhiFadlillah/duit/master/docs/readme/mobile.png)

## Installation

You can download the latest version of `duit` from release page. You can also build it from source by running :

```
go get -u -v github.com/RadhiFadlillah/duit
```

Make sure you have `go >= 1.13` before building it.

## Usage

```
Duit, the simple money manager
Usage:
duit [flags]
Flags:
-c, --config string path to config file (default "/home/radhi/.config/duit/config.toml")
-h, --help help for duit
-p, --port int port used by the server (default 8080)
```

## Configuration

Duit uses MariaDB or MySQL database, so make sure it's installed on your system before you start `duit`.

As can be seen from usage documentation above, `duit` needs to be configurated before it started. The configuration file by default is located in user config dir (which is `$XDG_CONFIG_HOME` in Linux), but can be set manually by user.

The configuration file is a TOML file with following contents (change it depending on your case) :

```toml
dbName = "duit"
dbUser = "root"
dbHost = "127.0.0.1"
dbPassword = ""
```

Once configuration file created, you can start using `duit`.

## Attributions

Original logo is created by [Freepik](https://www.flaticon.com/authors/freepik) in theirs [business pack](https://www.flaticon.com/packs/business-471), which can be downloaded from [www.flaticon.com](https://www.flaticon.com/).
Expand Down

0 comments on commit d4058d9

Please sign in to comment.