Installation
The best way to get started with Open Self Service is to create an application using one of our App starters. These provide pre-configured templates with all the necessary components, integrations, and best practices to accelerate your development.
App starters (Recommended)
We offer two starter templates to choose from:
O2S Customer Portal starter
For building customer self-service applications and portals:
npx create-o2s-app@latest my-customer-portal
DXP Frontend Starter
For building knowledge bases, marketing portals, and Digital Experience Platforms:
npx create-dxp-app@latest my-dxp-portal
Both starters will automatically:
- Download the latest template
- Install all dependencies
- Set up the project structure
- Initialize necessary integrations and configurations
Recommended approach: Start with one of our App starters. They provide the fastest path to a working application and include all the best practices and configurations you need.
For detailed information about each starter, see our App starters section.
Advanced: Cloning the repository
You can also clone the main repository to have access to every package that is not part of the starters (like docs or integrations):
git clone https://github.com/o2sdev/openselfservice.git
After that, all you need to do is to install the dependencies for each package:
npm install
Cloning the repository is a more advanced way of starting with O2S, and is suggested only when you need to modify the core functionalities of the framework.