BookKeepr

by Rogerio Taques.

BookKeepr - /ˈbo͝o(k)ˌkēpər/ - is a bookkeeping web app for small businesses and self-employed professionals in Japan. Designed to be simple and easy, it helps us keep track of incomes and expenses, therefore, making it easier to fill out the tax return at the end of each financial cycle. 100% free and open-source, under MIT license.

Supports both single-entry and double-entry methods.

What is bookkeeping?

It is the recording of financial transactions, and is part of the process of accounting in business and other organizations. It involves preparing source documents for all transactions, operations, and other events of a business.

Transactions include purchases, sales, receipts and payments by an individual person or an organization/corporation. There are several standard methods of bookkeeping, including the single-entry and double-entry bookkeeping systems.

While these may be viewed as "real" bookkeeping, any process for recording financial transactions is a bookkeeping process.

Source: Wikipedia.

Get started

Running locally (development)

Once this repository is cloned, open a terminal window and go to the project folder.

Run the backend (api) with:

cd backend
yarn install
yarn start

Run the frontend (app) with:

cd frontend
yarn install
yarn start

Next, open your preferred browser and visit to http://localhost:5173 and happy coding 🤘

Running the Docker image locally

First, build the image:

docker build --platform linux/amd64 -t abtzco/bookkeepr .

Warning

Note: Especially if you're building on a different host platform (e.g. Mac M1), you may need to use the --platform flag to specify the correct target platform.

Then, run the image:

docker run --rm --name bookkeepr -p 8090:8083 -v /tmp/bookkeepr:/bookkeepr/data abtzco/bookkeepr:latest

Note

By running the docker as above, all the data will be stored in /tmp/bookkeepr folder in your local machine.

Running the Docker image in PRODUCTION

BookKeeper is ready to be deployed so you can use it on the cloud.

For that, you need to spare a server where you can deploy and run docker containers. These steps assume your server has Docker installed.

Once you have SSHed into the server, run the following command to download the image:

docker pull abtzco/bookkeepr:latest

If you already have an old version of BookKeepr docker running, remove the existing container with the command below. If not, skip this step.

docker rm -f bookkeepr

Then, run the image:

docker run -d --restart always --name bookkeepr -p 80:8083 -v /home/<USER>/bookkeepr/data:/bookkeepr/data abtzco/bookkeepr:latest

Note

If needed, adjust the host port number accordingly. By running the docker with the above command, all the data will be stored in your server's /home/<USER>/bookkeepr/data folder.

Troubleshooting

If you run into problems related to sqlite3 and node-gyp while running yarn install or yarn start, try to downgrade sqlite to ^5.0.0 and install node-gyp globally with:

npm install -g node-gyp

Tech stack

• Node 20.17+
• Vue 3.4+
• SQLite

Questions?

Have a question or need some help?
Drop me a line on Twitter.

Bug reports and contributions

Please report bugs here. 🙇‍♂️

Also, contributions are very welcome as pull requests. If you find a bug, want to improve, or add a new feature, please open a PR. 🙏