Essential documents of the organization.
Go to file
2023-06-15 19:32:33 +02:00
.github remove whitespace 2022-12-16 19:02:16 +01:00
Legal Update. 2023-05-10 18:38:15 +02:00
Policies & Guidelines Update. 2023-05-10 18:38:15 +02:00
Processes Update 2023-06-15 19:32:33 +02:00
Workfiles Update 2023-06-15 19:32:33 +02:00
Documentation Type Overview.md remove whitespace 2022-12-16 19:02:16 +01:00
LICENSE.txt add docx tpl files and add license version 2022-09-19 19:13:19 +02:00
README.md update 2022-12-16 22:56:08 +01:00

Logo

The Organization Documentation contains the documentation of the organization. Additional documentation for developers or users may also exist.

With Karaka you have one partner who can provide all the tools and software solutions you are used to at fair and reasonable prices even for small organizations and companies/startups. Our solutions can be used independently from each other or fully integrated with other solutions we provide. By choosing Karaka as your partner you'll be able to adjust your software based on the changes in your requirements without worrying about integration and workflow optimization.

Table of Contents

Requirements

  • PHP 8.1
  • PHP extension: php8.1-dev php8.1-cli php8.1-common php8.1-mysql php8.1-pgsql php8.1-xdebug php8.1-opcache php8.1-pdo php8.1-sqlite php8.1-mbstring php8.1-curl php8.1-imap php8.1-bcmath php8.1-zip php8.1-dom php8.1-xml php8.1-phar php8.1-gd php-pear
  • apache2 (recommended) or nginx
  • mysql-server (recommended) or postgresql postgresql-contrib
  • Tools: tesseract-ocr, PDFtotext, PDFtoppm
  • Make sure that URL rewriting is active!

Developer tools

  • Php extension: xdebug
  • Tools: Composer, Npm
  • Composer tools: phpstan, phpunit, phpcs
  • Npm tools: eslint

Installation

Detailed installation instructions can be found at:

Philosophy & Demo

We believe software should support a business in it's daily tasks and growth in a very efficient way without frustration. In order to achieve this we constantly take feedback from our customers and expand and improve our software solutions.

You can find a freely available online demo at https://demo.karaka.app (user: admin, pass: orange) without any registration or inquiry.

Development status

Currently Karaka is still developing the first Alpha version. As soon as we have a running Beta version we are allowing external testers to use our software and a selected amount of inhouse developed modules.

General updates can be found in our info section at https://karaka.app/info and developer updates can be found in our developer section at https://karaka.app/dev. In our developer section you can also check out the automatically generated reports such as code coverage, code style, static analysis etc. as well as our code style guide lines and developer documentation.

Tech stack

  • Language: php, js, c++, html, css, markdown, shell script
  • Database: Maria/MySQL, PostgreSQL, MSSQL/SQLSrv, SQLite
  • Webserver: apache2, nginx
  • Cache: Redis, Memcached

Become a contributor

Karaka has a very open culture and we always welcome new people who share our philosophy in providing create solutions which just work. You can find the development process description which also describes how to become a contributer in the Project Documentation.

Misc