Contributing

Installation

Backend

Follow these instructions for the Go backend.

Frontend

Optional. If you wish to modify the frontend components, you’ll need to follow these additional instructions:

Clone the uchiwa-web repository:

git clone [email protected]:sensu/uchiwa-web.git && cd uchiwa-web

Install third-party libraries:

npm install # Standard user
npm install --unsafe-perm # Root user

Create a global link for uchiwa-web:

bower link

Move to your uchiwa repository directory:

cd $GOPATH/src/github.com/sensu/uchiwa

Uninstall the uchiwa-web bower component if previously installed:

bower uninstall uchiwa-web

Point the bower component uchiwa-web to the previously created link

bower link uchiwa-web

Development

Backend

Run the program:

go run uchiwa.go

N.B.: You’ll need to relaunch this command if you modify the source code to apply changes.

Frontend

Generate CSS files from Sass templates:

grunt sass

Testing

Backend

Run the unit tests:

go test -v ./...

Frontend

Run linting and unit tests:

grunt