diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9b4371..4bbb819 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ Generally, the development philosophy is result orientated. This means that anyo Developers are encouraged to pick open tasks with high priorities according to their own skill level. Senior developers may directly assign tasks to developers based on their importance. New developers may find it easier to start with a task that has a low priority as they often also have a lower difficulty. -Open tasks can be found in the project overview: [PROJECT.md](../Project/PROJECT.md) +Open tasks can be found in the project overview: [PROJECT.md](https://github.com/Karaka-Management/Organization-Guide/blob/master/Project/PROJECT.md) Tasks currently in development are prefixed in the priority column with an asterisk `*` and a name tag in the task description of the developer who is working on the task. diff --git a/README.md b/README.md index f930378..6105ff3 100755 --- a/README.md +++ b/README.md @@ -1,27 +1,75 @@ -# General +

Logo

-The **jsOMS** framework provides many features to manage and interact with the UI and connect the frontend to the backend for data exchange. Additionally to the framework features it also includes a library that provides additional functionality. +The **jsOMS** framework is primarily developed for the Karaka application which is a modular web application for small to mid sized companies that need CRM, ERP, Intranet and/or CMS functionalities and much more. The framework is also used in some other tools and websites which compliment the Karaka web application and provides the necessary php functionality. -## Features +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. -Features this framework provides are: +## Table of Contents -* UI action management -* UI manipulation -* Event management -* Form management -* Audio/Speech recognition -* Logging (console/backend) -* Asset management -* Input management (touch, mouse, keyboard) -* Math (e.g. matrix, string evaluation, etc.) -* Uri generation -* Charts -* Websockets -* Markdown -* Templating -* Cache/Storage management +- [Table of Contents](#table-of-contents) +- [Requirements](#requirements) + - [Developer tools](#developer-tools) +- [Installation](#installation) +- [Philosophy & Demo](#philosophy--demo) +- [Development status](#development-status) +- [Tech stack](#tech-stack) +- [Become a contributor](#become-a-contributor) +- [Misc](#misc) -# Development Status +## Requirements -The framework reached a point where it can be already used albeit many features are still under development. \ No newline at end of file +* 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: + +* [Developer Setup](https://github.com/Karaka-Management/Developer-Guide/blob/develop/general/setup.md) +* [User Setup](https://github.com/Karaka-Management/User-Guide/blob/develop/setup/install.md) + +## 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. + +* [Project Status](https://github.com/Karaka-Management/Organization-Guide/blob/master/Project/PROJECT.md) + +## Tech stack + +* Language: php, js, c++, html, css, markdown, shell script +* Database: Maria/MySQL, PostgreSQL, MSSQL, 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 [Organization documentation](https://github.com/Karaka-Management/Organization-Guide/blob/master/Processes/Development.md). + +## Misc + +* End-User documentation: https://github.com/Karaka-Management/Documentation +* Developer documentation: https://github.com/Karaka-Management/Developer-Guide +* Organization documentation: https://github.com/Karaka-Management/Organization-Guide +* Website: [https://karaka.app](https://karaka.app) +* Demo: [https://karaka.app](https://karaka.app) (user: admin, pass: orange) +* Dev: [https://karaka.app/dev](https://karaka.app/dev) +* Contact: dennis@karaka.app