https://github.com/captainayan/accountlite-cli

💡💰Lightweight Command line Double-Entry Accounting Software💵💸
https://github.com/captainayan/accountlite-cli

account-lite accounting commerce cpp finance journal journal-entries ledger parser personal statements trial-balance

Last synced: about 1 month ago
JSON representation

💡💰Lightweight Command line Double-Entry Accounting Software💵💸

• Host: GitHub
• URL: https://github.com/captainayan/accountlite-cli
• Owner: captainAyan
• License: mit
• Created: 2021-04-05T11:54:41.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-31T09:45:56.000Z (almost 3 years ago)
• Last Synced: 2023-05-10T19:36:56.188Z (over 1 year ago)
• Topics: account-lite, accounting, commerce, cpp, finance, journal, journal-entries, ledger, parser, personal, statements, trial-balance
• Language: C++
• Homepage: https://captainayan.github.io/accountlite/cli
• Size: 277 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
AccountLite CLI 💡

  


    Lightweight Double-Entry Accounting 💸 Software 🚀

    


    Documentation  

    Report Bug 😓

  


[![Screenshot](https://raw.githubusercontent.com/captainAyan/accountlite-cli/main/screenshots/1.png)](https://github.com/captainAyan/accountlite-cli)

## 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](https://github.com/captainAyan/accountlite-cli/releases/latest)

### As Developer

⚠ You must have [MinGW](https://sourceforge.net/projects/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](https://captainayan.github.io/accountlite/cli#docs)

## 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](https://github.com/captainAyan/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](https://github.com/captainAyan)