Merge pull request #1 from Orange-Management/develop

Develop

.github/contributing.md

@@ -0,0 +1 @@
+A developer and contribution documentation can be found at https://orange-management.gitbooks.io/developer-guide/content/index.html.

.github/issue_template.md

@@ -0,0 +1,24 @@
+### Expected behavior
+
+
+
+### Actual behavior
+
+
+
+### Steps to reproduce the behavior
+
+
+
+### Importance
+
+- [ ] Application breaking
+- [ ] High importance
+- [ ] Medium importance
+- [ ] Minor importance
+
+### Type
+
+- [ ] Bug
+- [ ] Enhancement
+- [ ] Security issue

App/ideas.md

@@ -0,0 +1,10 @@
+## Sales
+1. Print invoices based on filter (array of invoices)
+2. Make invoices only printable after they got checked (by a different person) (Optional)
+3. Client click opens accordion with client data
+
+## Navigation
+1. Maybe make sidebar tabbed 3-4 tabs at the top?
+2. Allow child elements on hover (for content navigation only?!)
+3. Mark links as dynamic request
+

App/module_list.md

@@ -0,0 +1,70 @@
+* 1000100000 - OMS Admin
+* 1000200000 - OMS Backend Dashboard
+* 1000300000 - OMS Profile
+* 1000400000 - OMS Media
+* 1000500000 - OMS Navigation
+* 1000600000 - OMS News
+* 1000700000 - OMS Monitoring
+* 1000800000 - OMS Surveys
+* 1000900000 - OMS Calendar
+* 1001000000 - OMS Business Expenses
+* 1001100000 - OMS Tasks
+* 1001200000 - OMS Messages
+* 1001300000 - OMS Warehouse Management
+* 1001400000 - OMS Payment Information
+* 1001500000 - OMS Arrival
+* 1001600000 - OMS Sales
+* 1001700000 - OMS Project Management
+* 1001800000 - OMS Chat
+* 1001900000 - OMS Marketing
+* 1002000000 - OMS AreaManager
+* 1002100000 - OMS Purchase
+* 1002200000 - OMS Research & Development
+* 1002300000 - OMS Credit Management
+* 1002400000 - OMS Human Resource Management
+* 1002500000 - OMS Clocking
+* 1002600000 - OMS Accounting
+* 1002700000 - OMS Reporter
+* 1002800000 - OMS Controlling
+* 1002900000 - OMS Support
+* 1003000000 - OMS Risk Management
+* 1003100000 - OMS Client Management
+* 1003200000 - OMS Supplier Management
+* 1003300000 - OMS Tools
+* 1003400000 - OMS MyPrivate
+* 1003500000 - OMS PersonnelTimeManagement
+* 1003600000 - OMS Checklist
+* 1003700000 - OMS Address
+* 1003800000 - OMS Contact
+* 1003900000 - OMS Reporting
+* 1004000000 - OMS Shipping
+* 1004100000 - OMS Chart
+* 1004200000 - OMS Event Management
+* 1004300000 - OMS Production
+* 1004400000 - OMS Cost Unit Accounting
+* 1004500000 - OMS Cost Center Accounting
+* 1004600000 - OMS Budget Management
+* 1004700000 - OMS Business
+* 1004800000 - OMS Item Management
+* 1004900000 - OMS Accounts Receivable
+* 1005000000 - OMS Accounts Payable
+* 1005100000 - OMS Billing
+* 1005200000 - OMS Draw
+* 1005300000 - OMS Editor
+* 1005400000 - OMS SalesAnalysis
+* 1005500000 - OMS Workflow
+* 1005600000 - OMS Database
+* 1005700000 - OMS Job
+* 1005800000 - OMS Kanban
+* 1005900000 - OMS Knowledgebase
+* 1006000000 - OMS QA
+* 1006100000 - OMS Comments
+* 1006200000 - OMS Auditor
+* 1006300000 - OMS Human Resource Time Recording
+* 1006400000 - OMS P&L
+* 1006500000 - OMS Balance
+* 1006600000 - OMS AssetManagement
+* 1006700000 - OMS StockTaking
+* 1006800000 - OMS Help
+* 1006900000 - OMS Home
+* 1007000000 - OMS Exchange

LICENSE.txt

@@ -0,0 +1,11 @@
+The OMS License 1.0
+
+Copyright (c) <Dennis Eichhorn> All Rights Reserved
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

Legal/GDPdU.md

@@ -0,0 +1,26 @@
+# GDPdU Requirements
+
+1. Complete storage of all documents (order, delivery note, invoice, accounting etc.)
+2. Complete history of same document in case of changes
+3. Long term storage
+4. Permission management to prevent altering
+5. Encrypting sensitive data (recommended not regulated)
+6. Deleting of data older than x must be possible (not earlier)
+7. Getting all data related to one person or issue must be possible
+8. Not certificate required (for Germany)
+9. Export control check (not GDPdU but still required)
+10. Deleting none business relevant data of user must be possible (EU law)
+11. Export of GDPdU files must be possible
+12. "E-balance must be possible" (doesn't have to be but then client has to create them manually)
+13. Regular backups must be ensured (also required for data security reasons)
+14. Unique invoice numbers
+15. Consecutive invoice numbers
+16. Correct invoice (delivery addrass, invoice address, date, vat id, items, amounts, single price, values, tax, discount, delivery terms, payment terms, skonti, currency, exchange rate, person who created invoice)
+17. Document correct working by logging every activity (e.g. invoice reduces stock and the stock log needs to reference the invoice id etc.)
+18. Every posting has to be related to a voucher
+19. Comment for posting possible
+20. IKS (cross check different areas e.g. P&L / Balance, allow to print checklists like all postings etc.)
+21. Document changes in settings (e.g. fiscal year change, change of invoice number layout)
+22. Check if documents are created correctly (all invoices where sent to customers)
+23. Exports need to be possible in excel and pdf
+24. Documentation of workflows (technical and manual part)

Legal/Licensee.md

@@ -0,0 +1,60 @@
+# Licenses #
+
+## Fonts ##
+
+### Font Awesome ###
+
+* Files: fontaweseom/*
+* License: https://fortawesome.github.io/Font-Awesome/license/
+* Source: https://fortawesome.github.io
+
+## JavaScript ##
+
+Core JavaScript libraries
+
+### D3.js ###
+
+* Files: d3.min.js
+* Author: Michael Bostock
+* License: https://github.com/mbostock/d3/blob/master/LICENSE
+* Source: https://github.com/mbostock/d3
+
+### Orange Fruit Pieces ###
+* Files: module_teaser_small.png
+* Author: Evan Amos
+* License: http://creativecommons.org/licenses/by-sa/3.0/deed.en
+* Source: http://commons.wikimedia.org/wiki/File:Orange-Fruit-Pieces.jpg
+
+## PHP
+
+Core PHP libraries
+
+### MPDF
+
+* Files: mpdf/*
+* License: https://github.com/mpdf/mpdf/blob/development/LICENSE.txt
+* Source: https://github.com/mpdf/mpdf
+
+### TCPDF
+
+* Files: tcpdf/*
+* License: https://github.com/tecnickcom/TCPDF/blob/master/LICENSE.TXT
+* Source: https://github.com/tecnickcom/TCPDF
+
+### PhpSpreadsheet
+
+* Files: PhpSpreadsheet/*
+* License: https://github.com/PHPOffice/PhpSpreadsheet/blob/develop/LICENSE
+* Source: https://github.com/PHPOffice/PhpSpreadsheet
+
+### PhpWord
+
+* Files: PHPWord/*
+* License: https://github.com/PHPOffice/PHPWord/blob/develop/LICENSE
+* Source: https://github.com/PHPOffice/PHPWord
+
+### PHPPresentation
+
+* Files: PHPPresentation/*
+* License: https://github.com/PHPOffice/PHPPresentation/blob/develop/LICENSE
+* Source: https://github.com/PHPOffice/PHPPresentation

Legal/Licensor.md

@@ -0,0 +1,15 @@
+# Licenses #
+
+## Schütz Dental GmbH
+
+* Duration: unlimited
+* Compensation: none
+* Rights: Unlimitd use
+* Limitations: No claim for updates, support, fixes, additional modules, customizations and no rights to distribute the software or parts of it in any form.
+
+## GDF Gesellschaft für dentale Forschung und Innovationen GmbH
+
+* Duration: unlimited
+* Compensation: none
+* Rights: Unlimitd use
+* Limitations: No claim for updates, support, fixes, additional modules, customizations and no rights to distribute the software or parts of it in any form.

Policies & Guidelines/Code of conduct.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at spl1nes.com@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

Policies & Guidelines/Confidentiality Policy.md

@@ -0,0 +1,49 @@
+# Confidentiality Policy
+
+This company confidentiality policy explains how we expect organization members and participants to treat confidential information. Members and participants will receive and handle personal, private and confidential information about clients, suppliers, partners and our organization. We want to make sure that this information is well-protected.
+
+This information must be protected for two reasons:
+
+1. Legally binding
+2. Backbone of our organization and products
+
+## Scope
+
+This policy affects all organization members, participants and affiliates who may have access to confidential information.
+
+## Policy Elements
+
+Confidential information is defined as either
+
+* technical information, including patent, copyright, trade secret, and other proprietary information, techniques, sketches, drawings, models, inventions, know-how, processes, apparatus, equipment, algorithms, software programs, software source documents, and formulae related to the current, future and proposed products and services regarding "Orange Management", or
+* non-technical information relating to "Orange Management" products, including without limitation pricing, margins, merchandising plans and strategies, finances, financial and accounting data and information, suppliers, customers, customer lists, purchasing data, sales and marketing plans, future business plans and any other information which is proprietary and confidential to this project.
+
+Members, participants and affiliates may have different levels of authorized access to confidential information.
+
+## Does
+
+* Lock or secure confidential information at all times
+* Shred confidential documents when they're no longer needed
+* Make sure you only view confidential information on secure devices
+* Only disclose information to other members when it's necessary and authorized
+* Return confidential documents befor leaving or discontinuing the relationship with the organization and delete copies from personal devices.
+
+## Don'ts
+
+* Use confidential information for any personal benefit or profit
+* Disclose confidential information to anyone outside of the organization
+* Replicate confidential documents and files and store them on insecure devices
+
+## Exceptions
+
+Confidential information may occasionally have to be disclosed for legitimate reasons. In such cases, the holder of the confidential information should document their disclosure procedure and collect all needed authorizations from senior organization members. During this process it may be required by the receiver of the confidential information to sign a non-compete and/or non-disclosure agreement (NDA). 
+
+Disclosing more information than needed must be avoided.
+
+## Consequences
+
+Disrespecting this policy possibly leads to legal actions. 
+
+## Survival
+
+This policy is binding even after separation.

Policies & Guidelines/Conflict of Interest Policy.md

@@ -0,0 +1,33 @@
+# Conflict of Interest Policy
+
+This policy will outline the rules regarding conflict of interest and the responsibilities in resolving any such discrepancies. 
+
+Conflict of interest may have significant implications on ones judgement and commitment to the organization, and by extension to the realization of its goals.
+
+## Scope
+
+This policy affects all organization members, participants and affiliates acting on behalf of the organization.
+
+## Policy Elements
+
+The relationship of all organization members, participants and affiliates should be based on mutual trust. As the organization is committed to preserve the interest of these people, it expects them to act only towards its own fundamental interests.
+
+Conflict of interest is defined as:
+
+* the ability o use ones position with the organization for personal advantage
+* engaging in activities that will bring direct or indirect profit to a competitor
+* using connection obtained through the organization for their own private purposes
+* using organization confidential information (see confidentiality policy) or organization resources to support an external entity
+* acting in ways that may compromise the organization's legality
+
+## Does
+
+When an employee understands or suspects that a conflict of interest exists, they should bring this matter to the attention of senior organization members so corrective actions may be taken. Senior members ust also keep an eye on potential conflict of interests of other members, partners and affiliates.
+
+In general it is advised to refrain from letting personal and/or financial interests and external activities come into opposition with the organization's fundamental interests.
+
+All conflicts of interest will be resolved as fairly as possible. Senior organization members have the responsibility of the final decision when a solution can be found.
+
+## Consequences
+
+Disrespecting this policy possibly leads to legal actions or excluding the involved person from any further activities of the organization if no solution can be found.

Policies & Guidelines/Organization Activity Policy.md

@@ -0,0 +1,9 @@
+# Organization Activity Policy
+
+Organization members are expected to do regular significant contributions to the project. 
+
+The organization doesn't define any fixed hours and expects the members to decide on their own committment. Long leave times of more than 3 weeks should be communicated in advance so other members can organize tasks according to this.
+
+Members must not spend more time than 40 hours per week on the organization as we believe output quality will drastically reduce over time.
+
+Extremely few or insignificant contributions may lead to the exclusion from the organization based on judgmental basis by a senior member. A member can expect to receive a warning in advance in order to provide the chance to increase the activity or provide reasons for the past activitis.

Policies & Guidelines/Organization Guidelines.md

@@ -0,0 +1,17 @@
+# Organization Guidelines
+
+## Customer
+
+For us customer satisfaction is the top priority. The sole purpose of our tools, products and services is to help our customers with their tasks. We constantly strive to incorporate feedback from our customers in order to improve ourselves our products and services.
+
+## Partnerships
+
+Every relationship we have with customers, suppliers, organization members and experts is considered a partnership. As we expect a very high commitment and quality from our partners we also aim to return the same amount of commitment and quality. In a joint effort we hope to create the best experience for everyone involved.
+
+## Members
+
+We are always open to accept talented or striving people to the organization. We encourage members to grow toegether with the organization in skills and passion. Open discussions and brainstorming are always encouraged to improve and innovate. 
+
+## Products & Services
+
+Our goal is to provide products and services at the highest quality to make our customers, members and partners in general happy. Our products are constantly improved and revised. While providing a high quality product is very important to us at least as important to us are the services we provide.

README.md

@@ -0,0 +1,3 @@
+# General
+
+General organization documents.

Strategy/Business Plan.md

@@ -0,0 +1,175 @@
+# Executive Summary
+
+# Organization
+
+The Orange Management organization is located Germany and founded in November 2015 by Dennis Eichhorn for developing the Orange Management application and sub-components which incorporates functions such as CRM, SRM, CMS, Shop and many more. 
+
+The main goal of the organization is to create products for companies and organizations of all sizes which allow them to manage their opperations from one application and interconnect them.
+
+## SWOT
+
+### Strengths
+
+#### Customer
+
+* Everything in one application. Organizations and businesses no longer have to use multiple services from different providers and potentially integrate them into their existing applications
+* Cheap for the customer compared to many other solutions
+* Easy to use with modern visuals and layouts. 
+* Good performance
+* Modular. The customer can decide which modules he needs
+* Real world oriented. Features are drafted and tested by business specialsts in the respective fields.
+* Optimized for mobile and desktop
+* Flexible setup (local or remote)
+* Regular updates. Either manually or automatically
+* Large amount of modules
+
+#### Technical
+
+* Modular structure is designed in a very scalable way
+* Multiple database support (mssql, mysql, postgresql)
+* Multiple cache support (file, memcache, redis)
+
+### Weaknesses
+
+#### Customer 
+
+* Installation for non-tech people is difficult (not the actuall app installation but the WAMP or LAMP installation)
+
+#### Technical
+
+* Request based code execution. Database and cache connection is request based and not persistent etc.
+* Concurrency is difficult to solve due to the request based code execution
+
+### Opportunities
+
+* Continuous digitalization and need to keep up with it
+* Price attractiveness for all sizes of organizations and businesses
+* Public free software tests (without registration)
+* Growing demand for managing data (also for small businesses)
+
+#### Technical
+
+* Programming language performance improvement through JIT implementation
+* Programming language performance improvement through usage of typehints during compilation
+
+### Threats
+
+#### External
+
+* Regulations. There are many different regulations for different regions and business fields that must be upheld
+* Small customers still want to own software and not rent it and pay for it every year.
+
+#### Internal
+
+* Own organization size/workload. A large amount of modules and tools are required to reach the critical size to make a product which is beneficial for a large amount of organizations and businesses
+
+## Strategy & Vision
+
+### Vision
+
+Orange Management tools are used by at least 1.000 organizations in 2023
+
+### Startegy
+
+#### Initial Phase
+
+##### Customer
+
+In the beginning the goal is to reach a large amount of organizations no matter the size. As it is easier to address smaller organizations since they usually are less invested in existing software solutions they will be the initial target group. For them no customizations will be done unless they can be integrated for everyone.
+
+For these customers the following points are most important:
+
+1. Price
+2. Ease of use
+3. Key modules
+
+###### Price
+
+The price should be very competitive. This could be achieved by providing a cheap basic package which includes the essentials for most organizations with a licence for up to **5** users. There could be different packages for different types of organizations. However a small organization should look at a package and immediately recognize that this basically contains everything they need. Small organizations need to have trust in a product without having to understand all the technical details of functionaltiy which may be required for larger organizations.
+
+At the same time the customer needs to be informed, that he can customize his package if he wants to (e.g. add additional modules). Only after providing these information the customer needs to be informed that he can also completely customize his modules if he so desires without a basic package. For mid- to large sized organizations other price strategies could be better.
+
+A basic package should not cost more than 10 EUR per month as this is comparable to other competitors. Competitors offer overall much less but compared to the basic package they are similar features.
+
+###### Ease of use
+
+Ease of use needs to be visible to the customer even before he purchases a package. In order portray that of course the modules themself have to be designed in a very intuitive way but also the available documentation has to be very easy to understand. Very often documentations expect a certain amount of pre-knowledge which confuses new users if they try to follow a documentation step-by-step. At the same time videos are very important for small organizations as they may rather watch a video than read through the documentation. 
+
+The videos should not have a long introduction and an outro which are very annoying if you want to go through some videos very fast and have to waste your time on intros and outros. The solution will be to only show a 3 sec image or splash screen as intro and an 3 sec outro image with contact, website and documentation details.
+
+The videos shoud be around 5 - 15 minutes long. Shorter than 5 minutes will lead to a large amount of videos which take time to search through and longer than 15 minutes will discourage users since they might not want to invest the time.
+
+###### Key modules
+
+The key modules in one package must give the user the impresseion that this includes all the basics he needs to manage the organization.
+
+Recommended modules for businesses are:
+
+* Admin
+* Organization
+* Media
+* Tasks
+* Media
+* Calendar
+* Accounting
+* P&L
+* ClientManagement
+* SupplierManagement
+* Invoicing
+* Payment reminder
+* CashManagement
+* Banking (FinTS/HBCI, EBICS)
+* ItemManagement
+* VoucherManagement
+* TaxManagement
+
+With these modules almost every small business could opperate. Smart advertisments could help to sell extending modules such as charting, balancing, cost center accounting, cost object accounting, warehousing etc.
+
+# Products & Services
+
+## Products
+
+1. CRM
+2. SRM
+3. ERP
+4. Intranet
+5. Shop
+6. CMS
+
+# Business Decissions
+
+## Programming Language
+
+In the following a ranking of numbers (1-10) will be used where 10 is the highest and 1 the lowest value. Many of these evaluations are pure subjective and based on the personal experiences made by the organization founder in 2018.
+
+| Description                             | PHP        | C/C++     | C#         | GO        | Java       | Rust      | NodeJS     | Python     |
+| --------------------------------------- | ---------- | --------- | ---------- | --------- | ---------- | --------- | ---------- | ---------- |
+| Language experieance                    | 10         | 4         | 6          | 1         | 3          | 2         | 2          | 1          |
+| Performance (runtime)                   | 5          | 10        | 9          | 9         | 9          | 10        | 7          | 3          |
+| Web integration (tools, api, libs)      | 10         | 4         | 10         | 9         | 9          | 4         | 10         | 9          |
+| Package management system               | 10         | 4         | 7          | ?         | 4          | 7         | 5          | ?          |
+| Webserver, Vserver, Rootserver support  | 10         | 7         | 7          | 7         | 7          | 7         | 7          | 8          |
+| Concurrency                             | "no"       | yes       | yes        | yes       | yes        | yes       | yes        | "no"       |
+| Community size for web applications     | 10         | 3         | 7          | 6         | 6          | 2         | 8          | 8          |
+| Community momentum                      | decreasing | stable    | increasing | stable    | decreasing | stable    | increasing | decreasing |
+| Code execution                          | request    | running   | running    | running   | running    | running   | running    | request    |
+| Code quality tools                      | 10         | ?         | ?          | ?         | ?          | ?         | ?          | ?          |
+| Availability of libs (e.g. pdf, excel)  | 10         | ?         | ?          | ?         | ?          | ?         | ?          | ?          |
+| Easy to install on own server/pc        | no         | yes       | yes        | yes       | yes        | yes       | no         | no         |
+| Availability on third party hosts       | 10         | 7         | 7          | 7         | 7          | 7         | 8          | 9          |
+
+The decision why Orange Management decided to use PHP came down to the following points:
+
+1. Since the web applications are supposed to run on all sizes of organizations and businesses PHP has the advantage with availability on simple (cheap) webservers.
+2. The request based code execution makes it less susceptible against errors (re-starting and monitoring the application etc.) and therefore better for non-tech people.
+
+# Action Plan
+
+1. First real world tests on testing company (admin, organization, task & reporter module)
+2. Create reports for the reporter module for the testing company
+3. Test importer module and import testing company data into application
+4. Let modules display importet data (read-only) (customers, suppliers, accounts, cost centers, cost objects, articles, invoices)
+5. Create reports based on exiting data
+6. Implement modify and create functionaly for the above mention imported modules (data)
+7. Further implement basic modules (news, profile, wiki, kanban, Q&A, calendar, messaging)
+8. Create new design