This project is developed using Angular CLI. In order to run and this project or develop on your own, you need to setup the following:
- Angular CLI (^1.5.0)
- Optional: Docker
Angular is based on nodejs and npm. In order to run the project locally on your machine, you need to install it's dependencies. You can achieve that by running npm install.
After execution, you will see a folder called node_modules containing all dependencies.
Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.
Run ng build to build the project. The build artifacts will be stored in the dist/ directory. Use the -prod flag for a production build.
Run ng test to execute the unit tests via Karma.
Scylla UI is dockerized. Our deployment process is completly based on Docker and Jenkis CI (deploying the image to our website) as well as Travis CI (running the tests and building the image).
You can build the image by running docker build -t bptlab/scylla-ui .. This will build the image based on our Dockerfile.
Pull image from hub.docker.com
As an alternative, you can pull our image from Docker Hub by running npm run build:docker (or docker pull bptlab/scylla-ui).
In order to run the app, we suggest the following command npm run start:docker (or docker run -p "8080:80" --rm -d bptlab/scylla-ui). Navigate to http://localhost:8080/.
The documentation for the Scylla UI is located in this repo's wiki.
MIT