Skip to content
Snippets Groups Projects

source code

Last edited by Pedro Pablo Cardona Arroyave

Repository information

Our code is stored in a Git repository hosted on GitLab. You can find the repository here:

Code organization

You may find a description of our project structure here: Project structure (Prosjektstruktur)

Build instruction

You may find an understandable guide for installation and build here: Installation (Installasjon)

Code documentation

Our back-end code has been thoroughly documented using JavaDoc standards, which provides a comprehensive understanding of the codebase. Additionally, we have documented all JavaScript functions in the front-end to ensure clarity and maintainability of our code. Furthermore, we have included inline-comments to explain complex logic in greater detail. Our documentation standards make it easy for new contributors to understand the codebase, and for existing developers to quickly navigate through the code and make necessary changes.

Contribution guidelines

We are thrilled to receive contributions to our codebase! To ensure a smooth and efficient process, please follow these guidelines:

  1. Before making any changes, create a new issue that describes the contribution you plan to add. This will help to ensure that your changes align with our project goals and development roadmap.
  2. Once the issue has been approved, create a new branch for the issue, using a descriptive name that summarizes the changes you plan to make.
  3. When you have completed your changes, push the branch to our Git repository. This will trigger our pipeline to check your changes for any issues or errors.
  4. If the pipeline check is successful, submit a merge request to the main branch. Please include a detailed description of your changes and any relevant information that may help us review your request.
  5. After your changes have been merged, close the issue and delete the branch from the repository. This helps to keep our repository organized and maintainable.

Thank you for your contribution to our project!

Thanks

We would like to extend our sincere appreciation to the Kassal.app team for generously allowing us to use their API calls in our project. Their support has been instrumental in enabling us to deliver a high-quality product.

We would also like to express our gratitude to Jeremy Long for sponsoring our front-end security check. Jeremy's contributions have helped us to identify and address potential security vulnerabilities in our code, ensuring that our product is robust and secure.

Once again, we would like to thank the Kassal.app team and Jeremy Long for their valuable contributions to our project.