COFFEE is the acronym for "COmpany eFFEEctive platform"
This project is a set of common libraries which help to improve productivity while developing from medium to huge C++ projects.
This project try to facilitate the development of medium to huge applications getting the twelve-factor methodology for building software-as-a-service apps. See https://12factor.net/ for more information.
This framework contains a set of modules to boost productivity while developing C++ applications. The modules are:
| Module | Comment |
|---|---|
| coffee.config | Low level macros defines to support different architectures. |
| coffee.basis | Defines classes that will be the fundation for all upper modules |
| coffee.xml | Defines and high level interface to work with XML documents. |
| coffee.logger | Best logging system you will see. If defines a fast common interfaces for lots of ways of write logs and formatters. |
| coffee.balance | Module for share load between a set of resources, it implements three different strategies and it does easy to write your own. A database connection will be a resource inherited from this kind of resource. |
| coffee.app | Define classes to make easy to run an application with lots of services. It deal with internal dependencias between services. One service is a large functionality which can depend on other services. An example of service could be one database or one communication system. |
| coffee.dbms | DataBase Manager System. It defines a common interface for work with any database you need (MySQL, PostgreSQL and more). |
| coffee.time | Service to manage asynchronuos time events. You have to define a valid TZ environment variable to run its unit tests |
| coffee.dbms.sqlite | Module to work with SQLite3 database. |
| coffee.dbms.ldap | Module to work with LDAP directory. |
| coffee.persistence | High Level of classes to work over a database without has to deal with SQL sentences, transactions and so on, it will work with classes, primrary keys and object that will be read/write from the DBMS. |
| coffee.networking | Service to manage asynchronuos messages using ZeroMQ library. |
| coffee.http | This will not implement all cases defined by RFC 2616, but it will define cases which I needed to develop microservices in a very easy way and very effective way |
You should have to use a g++ with support for c++11.
And should have installed the next packages:
sudo apt-get install cmake
sudo apt-get install libxml2-dev
sudo apt-get install libboost-filesystem-dev libboost-test-dev
sudo apt-get install libsqlite3-dev:amd64
sudo apt-get install sqlite sqlite3
sudo apt-get install libldap2-dev
sudo apt-get install libzmqpp-dev
If you want to generate API doc in HTML you should install:
sudo apt-get install doxygen
sudo apt-get install graphvizFor now it should be very simple.
Go to the root source directory and run
cmake .
it will create the needed infraestructure to generate all modules by calling make.
You can run the next command to compile libraries and program with Unit Tests
make
And the next command will run the unit tests:
make test
If you have installed doxygen then you will be able to run the next command to generate API docs
make doc
You can see more commands in the Travis CI configuration file .travis.yml
COFFEE - COmpany eFFEEctive Platform
Copyright (c) 2018 Francisco Ruiz (francisco.ruiz.rayo@gmail.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
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.