Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.53 KB

README.md

File metadata and controls

56 lines (44 loc) · 2.53 KB

AccountLite CLI 💡

Lightweight Double-Entry Accounting 💸 Software 🚀
Documentation   Report Bug 😓

Screenshot

About

AccountLite CLI is a lightweight accounting software with recording financial transactions (no inventory management available), classification(ledgers), and summarization(trial balance). The data is stored in a human readable format (which is very similar to CSV).

Getting Started

As User

Download the accountlite.exe binary executable file from the latest release

As Developer

⚠ You must have MinGW installed and setup on your computer. Check by typing g++ --h in your command line.

Windows

  1. Clone the repo and enter the folder
  2. Run make.bat or ./make.bat

Linux & Mac

  1. Clone the repo and enter the folder
  2. Run make.sh or ./make.sh

Documentation (For User)

Documentation is available here

File Description (For Developer)

File Name Description
book.bk This is our own format of storing the data.
commands.h This file contains all the valid commands
model.h This is a model for Journal, Ledger, and Entry
main.cpp Duh 😒
make.bat This file compiles the program for windows
make.sh This file compiles the program for mac and linux
parser.h This file contains parser namespace, which is there to help 'parse' and 'stringify' the data of the book.bk file.
statement.h This file contains methods for printing out statements (In this context statements also mean Journal, Ledger, and Trial Balance, although journal and ledger are not actually statements)
table.h Check out CppCliTable
ui.h This file contains methods for complex or multi-step interactions.
util.h Contains some miscellaneous utility functions.

Contribution

Just send me a pull request. Mention your discord or instagram id.

(if the instructions were unclear, please let me know)

Contact

Send me a message on discord or instagram. Check out my Profile Readme