Skip to content

Latest commit

 

History

History
79 lines (65 loc) · 2.71 KB

developer_setup.md

File metadata and controls

79 lines (65 loc) · 2.71 KB

Developer Setup

Logging in to the SUI requires a running instance of ManageIQ. Instructions on how to install ManageIQ can be found here.

Install Repository and Prerequisites

  • Have the ManageIQ repo cloned into a directory named manageiq, and ready to be started. See here for the steps required to setup ManageIQ.
  • Have the SUI repo at the same level as manageiq/, this ensures the SUI builds, yarn build, into the correct manageiq folder.
    git clone [email protected]:ManageIQ/manageiq-ui-service.git
    
  • Have nodejs v6.x and npm 3.x.x installed (npm should be installed with NodeJS)
  • If using nvm you can ensure you are using the correct node version with nvm use
  • Have yarn (^v1.0.1) globally installed.
    npm install -g yarn
    

Install Dependencies

cd manageiq-ui-service
yarn

Setup

  • From the manageiq-ui-service directory, build the production version of the SUI. This task will compile the assets and drop them into the manageiq/public/ui/service directory.
    yarn build
    
  • If you already have manageiq core running on port :3000 you can verify that the build worked correctly by visiting: http://localhost:3000/ui/service/login

Zanata setup

  • To upload our download files to Zanata you need create a file in the root of the project named zanata.local.json
    {
        "apiKey":"",
        "project":"",
        "version":"",
        "user":""
    }
    
  • Optionally you can set up these same variables as bash environment variables instead.

Development

  • From the manageiq directory, start the ManageIQ application to initiate the server listening on http://localhost:3000 order and serve up the REST API. Either one of the following commands can be used.

    bin/rails s
    
    MIQ_SPARTAN=minimal rake evm:start
    

    ☝️ (websockets may not work correctly)

  • From the manageiq-ui-service directory, start the development version of the service UI, which will initiate the UI listening on http://localhost:3001, and talking to the REST API at http://[::1]:3000. This command will also open a browser page to http://localhost:3001/login.

    yarn start
    
  • To use a remote database prepend the yarn start command as follows, where the PROXY_PROTOCOL is the asset protocol, if left empty defaults to http://, and PROXY_HOST is the IP address of the asset.

    PROXY_PROTOCOL=https:// PROXY_HOST=0.0.0.0 yarn start