Comet DXP

Docs

Visit https://docs.comet-dxp.com/ to view the documentation.

Getting started

Prerequisites

The following tools need to be installed on your local machine.

• Docker Desktop
• nvm

Setup workspace

Run the install.sh script to install dependencies and setup needed symlinks.

sh install.sh

It is recommend to run install.sh every time you switch to the main branch.

Start development processes

Start Comet Admin packages

yarn dev:admin

Start CMS packages

yarn dev:cms

It is also possbile to start specific microservices

yarn dev:cms:api # (api|admin|site)

Start Demo

yarn dev:demo

Demo will be available at

• Admin: http://localhost:8000/
• API: http://localhost:4000/
• Site: http://localhost:3000/

It is also possbile to start specific microservices

yarn dev:demo:api # (api|admin|site)

Start Storybook

yarn storybook

Storybook will be available at http://localhost:26638/

Develop in a project

additional Requirements

• watchman
• wml

./wml-add.sh ../example
wml start

Notes

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.