Peratorakka Client

A client for any Peratorakka server.

Peratorakka is a software system aimed to manage and track personal finances. It is made up of a client and server. In this repository, it has an implementation of the client which allows the users to interact with server. The server may be implemented in different programming language as long as it has compatible API.

Screenshots of this project can be found in author's post and in announcements. Currently, there is a public client available to access by common people. The public client can be found on https://peratorakka-client.pages.dev/. Just connect to the default public server found in the client and use [email protected] as the email and 12345678 as the password. To anyone who uses the public Peratorakka client, please use the client responsibly, so others can try it.

Below, I still retained the instructions on how to start the system.

Origin

Some parts of the repository was based from sveltekit branch of Web Template.

The template has been specialized for front-end development.

Usage

Initialization (for developers)

If you want to contribute, the repository should be initialized to adhere in Conventional Commits specification for organize commits and automated generation of change log.

Prerequisites

• Node.js environment
• pnpm (optional)

Instructions

1. By running the command below, all your commits will be linted to follow the Conventional Commits specification.

   $ npm install
   

   Or if you have installed pnpm, run the following command:

   $ pnpm install
   

2. To generate the change log automatically, run the command below:

   $ npx changelogen --from=[tag name or branch name or commit itself] --to=master
   

Notes

Want to contribute?

Please read the contributing guide for different ways to contribute in the project.

You can also make a financial contribution, no matter how small, to support its development and maintenance.

Author

Coded by Kenneth Trecy Tobias.

Disclaimer

This personal project may contain references to trademarks, which are included in good faith. However, it is important to note that such references do not indicate any endorsement, affiliation, or sponsorship by the respective trademark holders unless explicitly stated.