RSS Git Download  Clone
Raw Blame History 3kB 147 lines
Markdown rendered
[//]: #@corifeus-header

 [![Build Status](https://travis-ci.org/patrikx3/corifeus.svg?branch=master)](https://travis-ci.org/patrikx3/corifeus)  [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/patrikx3/corifeus/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/patrikx3/corifeus/?branch=master)  [![Code Coverage](https://scrutinizer-ci.com/g/patrikx3/corifeus/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/patrikx3/corifeus/?branch=master)  
---
# Corifeus Matrix

## Issues / Support
This is an open source project. Time is a precious thing, so I have no time to give support and fix issues for someone else. I fix a bug, when I have an error that I need. If you got an issue, error or bug, I hope someone will have time to do it for you, otherwise, you are on you own.

Though, if I know the solution, I will tell you.

If you want to extend, fix bugs and add in new features on your own time, I help you , as ```patrikx3``` is an orgnization. I can add in anyone in no time. Not forking, you become a member, do not even need a pull merge request.

### Node Version Requirement 
``` 
>=7.8.0 
```  
   
### Built on Node 
``` 
v7.10.0
```   
   
The ```async``` and ```await``` keywords are required.

Install NodeJs:    
https://nodejs.org/en/download/package-manager/    
  
# Description  

                        
[//]: #@corifeus-header:end




# Architecture

![Corifeus Architecture](https://patrikx3.tk/files/playground/corifeus-architecture/corifeus-p3x-tdd-component.svg)

## Interoperability
* Client
  * Javascript _latest_
    * TypeScript _latest_

* Server
  * NodeJs
  * JavaScript 

* Integration
  * Joomla
  * Wordpress
  * Drupal
  
## Version control systems
* Git
  
## Documentation
* JSDoc
  
## Template
* HTML
* Angular 2
* PDF
* Handlebars

## Style
* CSS
* SASS
* LESS - more users

## Data
* MongoDB / Mongoose
* XML
* REST
  
## Development
* Skeleton
* Iterative
* Refactored
* Driven
  * Model
  * Test
    * Unit / Behavior / Should - find something simpler than Should, I just need simple asserts
    * Mocha / Karma / Protractor      
    * **Only test the required specifications, don't test everything**

## Continuous integration / build
* Grunt
* Travis
* Scrutinizer
* Docker
* WebPack
  
## Schema / Model
* Mongoose

* Uses multiple models
  * master
    * settings
  * role
  * user / role / authentication / categories / tags
  * commercial / product / order / invoice
  * erp    

## Validation
* Shared / Same for client and server

## Internationalization
* Shared / Same for client and server

## Live
[ReactiveX](http://reactivex.io/)  
[SocketIO](http://socket.io/)

## Deployment
* Server
  * core
    * commercial
      * erp     
         
* Client
  * web angular 2 / angular material
    * core - login/profile
      * commercial - product/order/invoice
        * erp - stock/warehouse

## Scenarios
  * core + api/commercial + angular/commercial + web
  * core + api/erp + angular/erp + web  
  * core + api/erp + angular/erp + cordova + ios  
  * core + api/erp + angular/erp + cordova + android  
  * server/commercial + CLI  
  * server/erp + CLI  
  * ... etc ...




[//]: #@corifeus-footer

---
[**CORIFEUS**](https://pages.corifeus.tk/corifeus) Build v1.0.1255-100

[Corifeus](http://www.corifeus.tk) by [Patrik Laszlo](http://patrikx3.tk)

[//]: #@corifeus-footer:end