OpenPitrix Dashboard

Install

If you already installed git, setting up this repo is very simple:

git clone --depth 1 https://github.com/openpitrix/dashboard.git
cd dashboard
yarn && yarn dev

If you prefer to use docker:

docker pull openpitrix/dashboard
docker run --name openpitrix-dashborad -p 8000:8000 openpitrix/dashboard

If you prefer to use docker-compose:

docker-compose up --build

We also prepared a Makefile, if you installed make:

make build
make dev

See how to install requisites: install doc

Build

For development mode:

yarn dev

For production mode:

yarn prod

Test

For unit and integrate test:

yarn test

For e2e test:

yarn e2e

Architecture

See: arch doc

Join the community

For bug reporting, file an issue

Wanna help us to improve this project? Fork this repo, send your awesome PR.

We are happy to see you 😃