galaxyproject / cloudlaunch-ui

A user interface for the cloudlaunch app
MIT License
8 stars 13 forks source link
angular5 cloud hacktoberfest

.. image:: https://travis-ci.org/galaxyproject/cloudlaunch-ui.svg?branch=master :target: https://travis-ci.org/galaxyproject/cloudlaunch-ui

cloudlaunch-ui

A web user interface for the CloudLaunch application_. CloudLaunch is a ReSTful, extensible Django app for discovering and launching applications on cloud, container, or local infrastructure. A live version is available at https://launch.usegalaxy.org/.

More documentation about CloudLaunch is available at https://cloudlaunch.readthedocs.io/.

Installation

The recommended method for installing CloudLaunch is via its Helm chart https://github.com/cloudve/cloudlaunch-helm.

For a local installation of a development server, run the following.

  1. Clone the repository

.. code-block:: bash

$ git clone https://github.com/galaxyproject/cloudlaunch-ui.git
$ cd cloudlaunch-ui
  1. Install required libraries

Make sure you have node (version 6.*) installed. Then install dependencies with the following commands:

.. code-block:: bash

# Install typescript development support
npm install -g tsd
# Install angular-cli
npm install -g @angular/cli
# Install dependencies
npm install

Running the development server

To start the development server, run:

.. code-block:: bash

npm start

Or if you use yarn as your preferred package manager, yarn start.

Access the server at http://localhost:4200/. The app will automatically reload if you change any of the source files.

Alongside this development server, it’s necessary to run the CloudLaunch app (see README_ for it); default assumes the CloudLaunch app runs on 127.0.0.1:8000.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive/pipe/service/class.

Build

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.

Running unit tests

Run ng test to execute the unit tests via Karma_.

Running end-to-end tests

Run ng e2e to execute the end-to-end tests via Protractor_. Before running the tests make sure you are serving the app via ng serve.

.. _CloudLaunch application: https://github.com/galaxyproject/cloudlaunch/ .. _README: https://github.com/galaxyproject/cloudlaunch/blob/dev/README.rst .. _Karma: https://karma-runner.github.io .. _Protractor: http://www.protractortest.org/