README.md

Openline Oasis app

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

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

👋 Overview

TBD

🚀 Installation

set up a minikube environment

• This process has been tested in both macos and Ubuntu 20.04 the install process may need to be adapted for other platforms
• If you use codespaces, be sure to use the 4 core environment

Set up your mail configuraiton

Open the file

deployment/k8s/local-minikube/apps-config/channels-api.yaml

Update the values for the following env vars

• SMTP_SERVER_ADDRESS
• SMTP_SERVER_USER
• SMTP_SERVER_PASSWORD
• SMTP_FROM_USER

To setup the environment for inbound email you must follow the procedure here to set up Amazon SES to send e-mails to you

Once these steps are completed you can proceed to the deployment step

Run the deployment script

deployment/k8s/local-minikube/0-build-deploy-openline-oasis-local-images.sh build

after the script completes you can validate the status of the setup by running

kubectl -n oasis-dev get pods

To start the tunnels for the core services you can run the folowing

./2-start-tunnels.sh

🙌 Features

TBD

🤝 Resources

• For help, feature requests, or chat with fellow Openline enthusiasts, check out our slack community!
• Our docs site has references for developer functionality, including the Graph API

👩‍💻 Codebase

Technologies

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

• PostgreSQL - Data storage
• Go - Back end & API
• React & Typescript - Front end apps

Folder structure

openline-oasis/
├── deployment              
│   ├── infra               # Infrastructure-as-code
│   └── scripts             # Deployment scripts
└── packages
    ├── apps                # Front end web applications
    │   ├── oasis           # Slack for external omni-channel communications, built on customerOS
    ├── components
    │   ├── react           # React component library
    │   └── web             # Web component library
    ├── core                # Shared core libraries
    └── server              # Back end 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):

tsearle 💻 📖

Gabriel Gontariu 💻 👀

edifirut 👀

Lorenzo Mangani 📖

Jonty Knox 📖

🪪 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.