dcos/dcos-ui

Name: dcos-ui

Owner: DC/OS

Description: The UI for The Datacenter Operating System

Created: 2016-04-18 22:48:06.0

Updated: 2018-05-24 18:00:23.0

Pushed: 2018-05-24 18:01:06.0

Homepage: https://dcos.io/

Size: 44423

Language: JavaScript

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

DC/OS UI

The User Interface for The Datacenter Operating System.

The DC/OS UI is used by datacenter operators to administer and manage a datacenter. Developers use DC/OS UI to manage, deploy and debug their applications. The DC/OS UI sits at the top of the DC/OS stack along with the CLI.

• Issue tracker. Use component dcos-ui.
• Documentation
• Apache License v2

Usage

You can choose from two ways of developing this repository.

• Locally
• Docker

Local Development

Requirements

Node 8.9.x and NPM 5.6.x (and above) are required. We suggest using nvm or n to keep multiple Node versions on your system.

DC/OS Installation Instructions:

1. Follow the instructions here to install a local cluster.

2. Clone this repo:

   clone git@github.com:dcos/dcos-ui.git && cd dcos-ui
   

3. Install dependencies:

   i
   

4. Add developer files for config overrides:

   run scaffold
   

   This will create webpack/proxy.dev.js and src/js/config/Config.dev.js. These files aren't tracked by git and provide a place to override proxy and general dcos-ui configuration. Edit webpack/proxy.dev.js to point to the address of the dcos-vagrant machine.

5. Start the development server:

   start
   

6. Navigate to http://localhost:4200

Development with Docker

To start a development server run

er-compose up -d
er-compose exec toolchain /bin/bash # This opens bash inside of the docker container
start

Using External Plugins

DC/OS UI comes bundled with some internal plugins within the /plugins directory. You can also load more plugins from another directory and they will be loaded into DC/OS UI along with the internal plugins. To set a directory for external plugins run:

config set externalplugins ../relative/path/to/plugins/directory

Contributing

Contributing Guidelines

Testing

See more at the Testing section of the Contribution Guidelines.

License and Author

Copyright Mesosphere, Inc.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this repository except in compliance with the License.

The contents of this repository are solely licensed under the terms described in the LICENSE file included in this repository.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Authors are listed in Authors.md file.