search

openwhyd / openwhyd-electron

💻 Install Openwhyd on your computer, play music in the background
https://openwhyd.org/download
17 stars 5 forks source link

docs(setup): add dev setup instructions #28

Closed compiuta closed 4 years ago

compiuta commented 4 years ago

Closes #27 .

What does this PR do / solve?

Add documentation on how to run electron app locally.

Overview of changes

I modified the README.md file with the following:

Dev Setup

  1. Run openwhyd locally following the install guide https://github.com/openwhyd/openwhyd/blob/master/docs/INSTALL.md
  2. clone https://github.com/openwhyd/openwhyd-electron on your computer.
  3. Modify the const URL_PREFIX found in the file src/main.js from https://openwhyd.org to http://localhost:8080
  4. Now open a second terminal window and type the following commands
$ cd openwhyd-electron # Go into the repository
$ npm install # Install dependencies
$ npm start # The local electron app should pop open with Openwhyd's home page! 🎉