Skip to content

Latest commit

 

History

History
68 lines (43 loc) · 2.65 KB

README.md

File metadata and controls

68 lines (43 loc) · 2.65 KB

Dashboard

Dashboard is the web UI that allows users to interact with paralus. Built using react, the dashboard is responsive, fast and feature loaded. It allows you to easily work with your clusters. The intuitive UI helps you manage your organization, projects and clusters along with user permissions and access. It makes importing clusters and managing access to it easier and quicker.


Paralus Dashboard


Development Setup

Setup Paralus core

Follow the development setup guide to start Paralus core. The dashboard requires core to be running.

Install Dependencies

yarn install

Start Dashboard Development Server

yarn run start

Open http://localhost:3000 to access the dashboard.

Setup Admin User Account

Run following command inside root directory of paralus/paralus:

go run scripts/initialize/main.go \
        --org DefaultOrg \
        --partner DefaultPartner \
        --partner-host paralus.local \
        --admin-email admin@paralus.local \
        --admin-first-name Admin \
        --admin-last-name User

You will get the admin account password set link, like this:

Org Admin signup URL:  http://127.0.0.1:4433/self-service/recovery?flow=7c85618b-cc38-4f4f-895c-3540f1fe5149&token=sf7fHWXDW664Y1DAMg5QIJ6Hqg97Huu7

Open link in browser and set the password.

Now you can login to the dashboard using email ([email protected]) and password you have provided.

Community & Support

Contributing

The easiest way to start is to look at existing issues and see if there’s something there that you’d like to work on. You can filter issues with the label “Good first issue” which are relatively self sufficient issues and great for first time contributors.

Once you decide on an issue, please comment on it so that all of us know that you’re on it.

If you’re looking to add a new feature, raise a new issue and start a discussion with the community. Engage with the maintainers of the project and work your way through.