CustomerOS

CustomerOS is the easiest way to consolidate, warehouse, and build applications with your customer data.

_{Built with ❤︎ by the CustomerOS community!}

👋 Overview

CustomerOS is an open source development platform that enables the flexible and rapid development of customer-centric applications.

Feature	Description	Status
Analytics API	Privacy-centric replacement for Google Analytics	Roadmap
Auth	End-to-end identity solution for easy user authentication, sign-in, and permissions using OAuth.	Demo
customerDB	Backend server that host your customer data in a secure, compliant, and standards based way.	Demo
customerOS API	GraphQL API for reading, writing, and manipulating customer data.	Demo
Event trackers	First party event trackers fully integrated with customerDB, allowing you full visibility into how your customers are engaging with your apps and content	Preview
Launcher	Web application with built in SSO to launch into any app built into customerOS	Demo
Message store API	gRPC API for high-speed communication between customerOS and communications clients (like Oasis)	Demo
Settings	Web application where you configure and administer all Openline services	Roadmap
Web components	A library of web components that make it easy to interact with customer data in your front end applications	Roadmap

• Roadmap: Coming soon!
• Demo: We're still working out the kinks
• Preview: We're using it in Production. So are Openline Insiders.
• Stable: Battle tested. Everyone is using it in Production.

🚀 Installation

1. Download and install the CustomerOS CLI
2. Run the following command

openline dev start customer-os

🤝 Resources

• Our docs site has numerous guides and reference material for to make building on customerOS easy.
• For help, feature requests, or chat with fellow Openline enthusiasts, check out our slack community!

Codebase

Technologies

Here's a list of the big technologies that we use:

• PostgreSQL & Neo4j - Data storage
• Go - Back end & API
• TypeScript - Web components
• React - Front end apps and UI components

Folder structure

openline-customer-os/
├── architecture            # Architectural documentation
├── deployment              
│   ├── infra               # Infrastructure-as-code
│   └── scripts             # Deployment scripts
└── packages
    ├── apps                # Front end web applications
    │   ├── launcher        # customerOS app launcher & home screen
    │   └── settings        # customerOS system settings & app configuration
    ├── auth                # Authentication
    ├── components
    │   ├── react           # React component library
    │   └── web             # Web & UI component library
    ├── core                # Shared core libraries
    └── server              # Back end database & API server

💪 Contributions

• We love contributions big or small! Please check out our guide on how to get started.
• Not sure where to start? Book a free, no-pressure, no-commitment call with the team to discuss the best way to get involved.

✨ Contributors

A massive thank you goes out to all these wonderful people (emoji key):

Matt Brown 📖

Vasi Coscotin 📖

alexopenline 💻

edifirut 🚇 👀

Jonty Knox 👀

tsearle 💻 📖

Alex Calinica 👀 ⚠️ 💻

SilviuOpenline 👀 ⚠️ 💻

🪪 License

• This repo is licensed under Apache 2.0, with the exception of the ee directory (if applicable).
• Premium features (contained in the ee directory) require an Openline Enterprise license. See our pricing page for more details.
• Copyright © Openline Technologies Inc. 2022 - 2024