Skip to content

Latest commit

 

History

History
147 lines (112 loc) · 5.35 KB

README.md

File metadata and controls

147 lines (112 loc) · 5.35 KB
Raw

Build Status Build status codecov Codacy Badge

seed-cpp — Seed for C++ Systelab projects

This project is an application skeleton for a typical C++ application. You can use it to quickly bootstrap your projects and dev environment.

The seed contains a Patient Management sample REST API.

The app doesn't do much, just shows how to use different C++ patterns and other suggested tools together:

Download from bintray

Not available yet. Meanwhile, you can build it from sources.

Build from sources

To build the application, the following prerequisites are mandatory:

On Linux, Homebrew (http://brew.sh/) is good alternative to install the prerequisites. If you have Homebrew installed, run the following commands:

brew install git
brew install conan
brew install cmake
brew install gcc

To build the application, we will follow the next steps:

  1. Clone this repository in a local drive
  2. Make a build directory (i.e. build/)
  3. Register bintray repository for Systelab libraries on conan
  4. Install conan dependencies in the build directory
  5. Run cmake in the build directory to configure build targets
  6. Use Visual Studio (on Windows) or make (on Linux) to build the library

Windows

In order to build the application on Windows for the Release configuration, run the following commands ($VSINSTALLPATH is the path where Visual Studio has been installed):

git clone https://github.com/systelab/seed-cpp
cd seed-cpp
md build && cd build
conan remote add systelab-bintray https://api.bintray.com/conan/systelab/conan
conan install .. -s build_type=Release -s compiler.toolset=v141 -s arch=x86_64
cmake .. -G "Visual Studio 15 2017 Win64"
"$VSINSTALLPATH/devenv.com" SeedCpp.sln /build "Release" /PROJECT "SeedCpp"

However, if you want to Debug the source code, you will need these commands:

git clone https://github.com/systelab/seed-cpp
cd seed-cpp
md build && cd build
conan remote add systelab-bintray https://api.bintray.com/conan/systelab/conan
conan install .. -s build_type=Debug -s compiler.toolset=v141 -s arch=x86_64
cmake .. -G "Visual Studio 15 2017 Win64"
"$VSINSTALLPATH/devenv.com" SeedCpp.sln /build "Debug" /PROJECT "SeedCpp"

Linux / MacOS

In order to build the application on Linux, run the following commands:

git clone https://github.com/systelab/seed-cpp
cd seed-cpp
mkdir build && cd build
conan remote add systelab-bintray https://api.bintray.com/conan/systelab/conan
conan install .. -s compiler.libcxx=libstdc++11
cmake .. -DCMAKE_BUILD_TYPE=[Debug | Coverage | Release]
make

Usage

To run the application, just launch the SeedCpp executable.

Use the following commmand line options:

--help     to produce help message
--cors     to enable cors (by default is disabled)
--port     arg to set an specific port (by default is 8080)
--https    to enable HTTPS support

For example:

SeedCpp --port 80 --https

In Linux and macOS, if you have the error 'dyld: Library not loaded', as a workaround, please copy the generated *.dyld libraries to /usr/local/lib

Login

Before any request, users must authenticate to the REST API by using the login endpoint (with username Systelab and password Systelab):

curl -v -d "login=Systelab&password=Systelab" -H "Content-Type: application/x-www-form-urlencoded" http://127.0.0.1:8080/seed/v1/users/login

The response for this request should contain an authentication token (based on JWT) in the Authorization header:

* Trying 127.0.0.1...
* TCP_NODELAY set
* Connected to 127.0.0.1 (127.0.0.1) port 8080 (#0)
> POST /seed/v1/users/login HTTP/1.1
> Host: 127.0.0.1:8080
> User-Agent: curl/7.54.0
> Accept: */*
> Content-Type: application/x-www-form-urlencoded
> Content-Length: 32
> 
* upload completely sent off: 32 out of 32 bytes
* HTTP 1.0, assume close after body
< HTTP/1.0 200 OK
< Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOiIxNTUzOTMxNTU3Iiwic3ViIjoiU3lzdGVsYWIifQ.AcpzW6QZMLZ39ST0tXBzz7ZAWDWyzATd3nJxZsMRxdQ
< Content-Length: 0
< Content-Type: application/json
< 
* Closing connection 0

This token should be added as an Authorization header in further requests to the REST API.

Documentation

See Documentation section for further details about available endpoints as well as other technical specifications.