vivid-planet / comet

Comet DXP

Comet DXP

Docs

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

Create a new Comet DXP project

Use @comet/create-app to create a new Comet DXP project. More information can be found in the docs.

Development

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 recommended to run install.sh every time you switch to the main branch.

Start development processes

dev-process-manager is used for local development.

Start Comet Admin packages

pnpm run dev:admin

Start CMS packages

pnpm run dev:cms

It is also possbile to start specific microservices

pnpm run dev:cms:api # (api|admin|site)

Start Demo

pnpm run 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

pnpm run dev:demo:api # (api|admin|site)

Start Storybook

pnpm run storybook

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

Start Docs

pnpm run docs

The docs will be available at http://localhost:3000/

Stop Processes

npx dev-pm shutdown

Develop in a project

additional Requirements

• watchman
• wml

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

Contributing

Please read our Contributing file.