Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/customeros/customeros

CustomerOS is an open source platform that enables you to bring your customer back to the center of your work.
https://github.com/customeros/customeros

eventstore golang graphql grpc neo4j nextjs postgresql react typescript

Last synced: about 1 month ago
JSON representation

CustomerOS is an open source platform that enables you to bring your customer back to the center of your work.

Awesome Lists containing this project

README

        






CustomerOS Logo








CustomerOS




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


[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen?logo=github)][customerOS-repo]
[![license](https://img.shields.io/badge/license-Apache%202-blue)][apache2]
[![stars](https://img.shields.io/github/stars/openline-ai/openline-customer-os?style=social)][customerOS-repo]
[![twitter](https://img.shields.io/twitter/follow/openlineAI?style=social)][twitter]
[![slack](https://img.shields.io/badge/slack-community-blueviolet.svg?logo=slack)][slack]




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][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][cli]
2. Run the following command

```sh-session
openline dev start customer-os
```

## 🤝 Resources

- Our [docs site][docs] 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][slack]!

## 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

```sh
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][contributions].
- Not sure where to start? [Book a free, no-pressure, no-commitment call][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][emoji]):



Matt Brown
Matt Brown

📖
Vasi Coscotin
Vasi Coscotin

📖
alexopenline
alexopenline

💻
edifirut
edifirut

🚇 👀
Jonty Knox
Jonty Knox

👀
tsearle
tsearle

💻 📖
Alex Calinica
Alex Calinica

👀 ⚠️ 💻
SilviuOpenline
SilviuOpenline

👀 ⚠️ 💻

## 🪪 License

- This repo is licensed under [Apache 2.0][apache2], 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][pricing] for more details.
- Copyright © Openline Technologies Inc. 2022 - 2024

[apache2]: https://www.apache.org/licenses/LICENSE-2.0
[call]: https://meetings-eu1.hubspot.com/matt2/customer-demos
[cli]: https://docs.customeros.ai/en/cli/getting-started
[contributions]: https://github.com/openline-ai/community/blob/main/README.md
[customerOS-repo]: https://github.com/openline-ai/openline-customer-os/
[docs]: https://docs.customeros.ai/
[emoji]: https://allcontributors.org/docs/en/emoji-key
[oasis]: https://github.com/openline-ai/openline-oasis
[pricing]: https://www.customeros.ai/pricing
[slack]: https://join.slack.com/t/openline-ai/shared_invite/zt-1i6umaw6c-aaap4VwvGHeoJ1zz~ngCKQ
[twitter]: https://twitter.com/OpenlineAI