Getting started | Oat++ (original) (raw)

Welcome to 🌱Oat++

# The recommended way to go

1. Install oatpp:
   • Unix/Linux
   • Windows
   • For exotic platforms look for stories on the Supported Platforms page.
2. Take a look at:
   • High Level Overview - Learn about the main components and features of Oat++.
   • Step By Step Guide - How to create an Oat++ project from scratch. Get more low-level details.
3. Check out examples and starter-projects:
   • Starter Project - Simple API
   • Starter project - Async API
4. 👉Join dev community and don't hesitate to ask questions - Chat On Gitter👈✌️

# Examples

# REST-API

• REST Service - A complete example of a "CRUD" service (UserService) built with Oat++. REST + Swagger-UI + SQLite.
• REST Client - Example project of how-to use Retrofit-like client wrapper (ApiClient) and how it works.

# WebSocket

• Can Chat - Feature-complete rooms-based chat for tens of thousands users. Client plus Server.
• WebSocket - Collection of oatpp WebSocket examples.
• YUV Websocket Stream - Example project how-to create a YUV image stream from a V4L device (i.E. Webcam) using websockets.

# Databases

• SQLite - A complete example of a "CRUD" service. REST + Swagger-UI + SQLite.
• PostgreSQL - Example of a production-grade entity service storing information in PostgreSQL. With Swagger-UI and configuration profiles.
• MongoDB - Example project how to work with MongoDB using oatpp-mongo mondule. Project is a web-service with basic CRUD and Swagger-UI.

# IoT

• Example-IoT-Hue - Example project how-to create an Philips Hue compatible REST-API that is discovered and controllable by Hue compatible Smart-Home devices like Amazon Alexa or Google Echo.

# Streaming

• HTTP Live Streaming Server - Example project on how to build an HLS-streaming server using Oat++ asynchronous API.
• YUV Websocket Stream - Example project how-to create a YUV image stream from a V4L device (i.E. Webcam) using websockets.

# TLS

• TLS With Libressl - Example project how-to setup secure connection and serve via HTTPS.

# Microservices

• Consul Integration - Example project on how to use oatpp::consul::Client. Consul integration.
• Microservices - Example project on how to build microservices with Oat++, and example on how to consolidate those microservices using monolithization technique.

# Asynchronous API

• Async Service - Example project on how to use asynchronous API to handle a large number of simultaneous connections.