| 1 | # Cypress Core Desktop Gui [](https://circleci.com/gh/cypress-io/cypress-core-desktop-gui)
|
| 2 |
|
| 3 | 
|
| 4 |
|
| 5 | The desktop GUI is the desktop application [installed](https://on.cypress.io/guides/installing-and-running#section-installing) to the user's OS using the `cypress install` command from the [Cypress CLI](https://github.com/cypress-io/cypress-cli) or through [direct download](http://download.cypress.io/desktop).
|
| 6 |
|
| 7 | The desktop GUI has the following responsibilities:
|
| 8 |
|
| 9 | - Allowing users to login through GitHub.
|
| 10 | - Allowing users to add projects to be tested in Cypress.
|
| 11 | - Displaying existing projects and allowing the removal of projects.
|
| 12 | - Initializing the server to run on a specific project.
|
| 13 | - Allowing users to choose a specific browser to run tests within.
|
| 14 | - Displaying the resolved configuration of a running project.
|
| 15 | - Displaying the list of tests of a running project.
|
| 16 | - Initializing the run of a specific test file or all tests chosen by the user.
|
| 17 | - Notifying users of updates to Cypress and initializing update process.
|
| 18 |
|
| 19 | ## Installing
|
| 20 |
|
| 21 | ```bash
|
| 22 | npm install @cypress/core-desktop-gui
|
| 23 | ```
|
| 24 |
|
| 25 | ## Developing
|
| 26 |
|
| 27 | To run the GUI in dev mode, you need to run the [Cypress App](https://github.com/cypress-io/cypress-app).
|
| 28 |
|
| 29 | - Navigate to `cypress-app` and run the following commands:
|
| 30 |
|
| 31 | ```bash
|
| 32 | npm i
|
| 33 | npm start
|
| 34 | ```
|
| 35 |
|
| 36 | The GUI should now be in your taskbar. Click in the taskbar to open it.
|
| 37 |
|
| 38 | In your console, you will probably see the following error:
|
| 39 |
|
| 40 | ```bash
|
| 41 | Error: connect ECONNREFUSED 127.0.0.1:1234
|
| 42 | > It looks like you're not running the local api server in development. This may cause problems running the GUI.
|
| 43 | ```
|
| 44 |
|
| 45 | In order to access the api to do things like logging into the GUI, we need to run the [Cypress API](https://github.com/cypress-io/cypress-api). Navigate to `cypress-api` and run the following commands:
|
| 46 |
|
| 47 | ```bash
|
| 48 | npm i
|
| 49 | npm start
|
| 50 | ```
|
| 51 |
|
| 52 | If you get any errors doing the above commands, go through the [install instructions](https://github.com/cypress-io/cypress-api) of the cypress-api app.
|
| 53 |
|
| 54 | ## Testing
|
| 55 |
|
| 56 | ```bash
|
| 57 | npm test
|
| 58 | ```
|
| 59 |
|
| 60 | ## Debugging
|
| 61 |
|
| 62 | If you want to see the `ipc` events which are pending from Cypress tests:
|
| 63 |
|
| 64 | - Switch to 'Your App' frame
|
| 65 | - App.ipc() <-- returns you object with pending events
|
| 66 |
|
| 67 | ## License
|
| 68 | LGPL
|
| 69 |
|
| 70 | ## Changelog
|
| 71 |
|
| 72 | #### 0.3.9 - *(10/14/16)*
|
| 73 | - fixed errors with undefined values being called
|
| 74 |
|
| 75 | #### 0.3.8 - *(10/13/16)*
|
| 76 | - explain how to manually update cypress during update fail
|
| 77 |
|
| 78 | #### 0.3.7 - *(10/05/16)*
|
| 79 | - shrinkwrap to prevent breaking dep change
|
| 80 |
|
| 81 | #### 0.3.6 - *(10/03/16)*
|
| 82 | - deploy proper prod files, fix mobx action undefined values
|
| 83 |
|
| 84 | #### 0.3.5 - *(09/13/16)*
|
| 85 | - previously chosen browser is saved per user and selected by default
|
| 86 |
|
| 87 | #### 0.3.4 - *(08/31/16)*
|
| 88 | - fix github focus button
|
| 89 |
|
| 90 | #### 0.3.3 - *(08/30/16)*
|
| 91 | - added applying updates view
|
| 92 |
|
| 93 | #### 0.3.2 - *(08/30/16)*
|
| 94 | - fixes dist dir and updates.html
|
| 95 |
|
| 96 | #### 0.3.1 - *(08/30/16)*
|
| 97 | - fix for incorrect references in index.html
|
| 98 |
|
| 99 | #### 0.3.0 - *(08/30/16)*
|
| 100 | - new UI, migrated to react
|
| 101 |
|
| 102 | #### 0.2.2
|
| 103 | - renamed Login -> Log In
|
| 104 |
|
| 105 | #### 0.2.1
|
| 106 | - internal updates to cypress.json settings change notification
|
| 107 |
|
| 108 | #### 0.2.0
|
| 109 | - display list of launchable browsers
|
| 110 | - handle error when no browsers available
|
| 111 |
|
| 112 | #### 0.1.5
|
| 113 | - updated node version to 5.10.0
|
| 114 |
|
| 115 | #### 0.1.4
|
| 116 | - added link to gitter chat in options popup
|
| 117 |
|
| 118 | #### 0.1.3
|
| 119 | - added specific error msg and link to docs on unauthed login
|
| 120 |
|
| 121 | #### 0.1.2
|
| 122 | - updated license
|
| 123 |
|
| 124 | #### 0.1.1
|
| 125 | - renamed to cypress-core-desktop-gui
|
| 126 | - removed dead code
|
| 127 |
|
| 128 | #### 0.1.0
|
| 129 | - initial release
|