Poor-Fox

by diegomacario

diegomacario / Poor-Fox

A beautiful command-line application designed to help you keep track of your expenses.

130 Stars 3 Forks Last release: almost 4 years ago (v1.0.0) MIT License 29 Commits 1 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Poor Fox

A beautiful command-line application designed to help you keep track of your expenses.

Features

  • Create your own expense categories.
  • Log your expenses using the 3-letter codes generated by the application.
  • Visualize the total you spend on each category through monthly reports.
  • Add new expense categories to an existing database.

Technical details

  • Supported on macOS, Linux and Windows.
  • Data is stored locally using SQLite.
  • Terminal string styling is done using Chalk.

Installation

Requirements

Have Node.js, npm and Chalk installed in your system.

  • To install Node.js and npm in macOS you can follow these instructions.
  • To install Node.js and npm in Linux you can execute the following commands:
    sh
    $ sudo apt-get update
    $ sudo apt-get install nodejs
    $ sudo apt-get install npm
    
  • To install Node.js and npm in Windows you can follow these instructions.

To install Chalk you can then execute the following command:

sh
 $ npm install --save chalk

macOS

To install the application globally, execute the command below.

sh
 $ curl -s -L https://github.com/diegomacario/Poor-Fox/raw/master/installer/unix_installer.sh | sudo bash -s macos
This command downloads the binary pfoxmacOS_ included in release 1.0.0 and places it in your /usr/local/bin/ folder.

Linux

To install the application globally, execute the command below.

sh
 $ curl -s -L https://github.com/diegomacario/Poor-Fox/raw/master/installer/unix_installer.sh | sudo bash -s linux
This command downloads the binary pfoxlinux_ included in release 1.0.0 and places it in your /usr/local/bin/ folder. If you do not have Curl installed, execute the following command first:
sh
 $ sudo apt-get install curl

Windows

To install the application globally, download the executable named pfoxwindows.exe_ included in release 1.0.0, rename it as pfox.exe and place it in a folder that's on the PATH environment variable.

Usage

Note: The application features clear error messages that will guide you when you make mistakes.

1. Create your own expense categories:

sh
 $ pfox new -Groceries -Restaurants -Movies -Shows -Clothes -Books -Photography -Climbing
- The application automatically generates codes that you can use to log expenses into each category. - Codes normally consist of the first 3 letters of each category. - Don't worry if 2 or more categories start with the same 3 letters (e.g. -Transportation -Travelling), the application will always generate unique codes.

2. Log the money you spent on a particular day by specifying its date in the format day/month/year: ```sh $ pfox log -d=1/12/2016 -gro=64.32 -boo=36.22 -mov=12.25

$ pfox log -d=16/12/2016 -mov=12.25 -cli=21.34 ```

  • The application automatically displays an expense report for the month you specified.
    • The table at the top displays the expenses that have been logged into each category separated by day.
    • The second table and the bar graph display the total spent in each category.
    • The global value at the bottom is the sum of all the totals.
  • If you do not specify a date, today's date is selected by default.
  • You can log expenses using the same date more than once. The expenses you enter will be added to the existing ones.
  • You can log negative values to make corrections when you enter incorrect amounts.
  • Dates are sorted automatically.

3. Add new expense categories to an existing database:

sh
 $ pfox add -Skydiving -Dancing
- Useful for when you pick up new hobbies and activities!

4. Display the expense report of a particular month by specifying its date in the format month/year:

sh
 $ pfox tab -d=12/2016

5. Display the months in which you have logged expenses:

sh
 $ pfox dat

6. Display the expense categories included in your database and their codes:

sh
 $ pfox cat

7. Delete your database so that you can create a new one:

sh
 $ pfox reset

8. See examples of how to use the application:

sh
 $ pfox help

9. See what version of the application you are using:

sh
 $ pfox version

Why should you use it?

Just like this application, your bank generates monthly reports of your expenses. The big difference between the two is that your bank generates those reports without any effort from you, while this application requires you to enter your expenses manually. That might seem like a lot of work, but I consider it to be a benefit because it will help you be more conscious about your spending, which is something that a report that you look at once a month will never do.

Log your expenses for a couple of months and you'll find all the categories in which you can improve. You will be surprised! Then use the money you save to learn or experience something new.

You planning all the fun things you are going to do.

Why is it called Poor Fox?

Mr. Fox: I don't want to live in a hole anymore. It makes me feel poor.
Mrs. Fox: We are poor -- but we're happy.

If you haven't watched Fantastic Mr. Fox yet, make time in your schedule to watch it with your loved ones. You will feel elated!

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.