├── HOW_TO_DEBUG.md
├── README.md
└── TROUBLESHOOTING.md


/HOW_TO_DEBUG.md:
--------------------------------------------------------------------------------
 1 | # Debugging Monaca Localkit
 2 | 
 3 | Although Monaca Localkit source code are obfuscated, you can save log output to a specific file.
 4 | To do so, please open *Preferences* and specify the file to dump the log output.
 5 | 
 6 | ## Running with the debugging parameter
 7 | 
 8 | Monaca Localkit will run in debug mode when `debug` parameter is set in the 2nd option. See the example below.
 9 | 
10 | ```
11 | > cd /path/to/localkit
12 | > monaca-localkit . debug
13 | ```
14 | 
15 | Please note that when running in the debug mode, it will output all network requests.
16 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Localkit
 2 | 
 3 | This contains release version of Monaca Localkit. Please use this repository for the change logs and issue report.
 4 | 
 5 | The latest version: v5.0.1
 6 | 
 7 | * [Change log](https://github.com/monaca/Localkit/releases)
 8 | * [List of issues](https://github.com/monaca/Localkit/issues)
 9 | * [Monaca Cloud issues](https://monaca.io/headline/fault.html) (external link)
10 | 
11 | ## Resources
12 | 
13 | * [How to debug](HOW_TO_DEBUG.md)
14 | * [Troubleshooting](TROUBLESHOOTING.md)
15 | * [Monaca updates](https://monaca.io/headline/index.html) (external link)
16 | * [Getting Started with Monaca Localkit](https://en.docs.monaca.io/tutorials/monaca_localkit) (external link)
17 | 


--------------------------------------------------------------------------------
/TROUBLESHOOTING.md:
--------------------------------------------------------------------------------
 1 | # Troubleshooting
 2 | 
 3 | ## Problem after installation (Windows OS):
 4 | 
 5 | I successfully installed Monaca Localkit, but after writing my credentials and pressing Sign In button, the UI freezes.
 6 | 
 7 | ## Solution:
 8 | 
 9 | The problem might be in the installation of Node.js. If you installed Node.js through [.msi installer](https://nodejs.org/en/download/) on Node.js official website, we suggest you to use `NVM for Windows` to manage your Node.js versions instead.
10 | 
11 | 1. Uninstall Node.js from your computer. Refer to this [manual](https://stackoverflow.com/questions/20711240/how-to-completely-remove-node-js-from-windows).
12 | 2. Install [NVM for Windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows).
13 | 3. After installation, download a Node.js version 14.19.0 and set this version to be used:
14 |    ```bash
15 |    $ nvm install 14.19.0
16 |    $ nvm use 14.19.0
17 |    ```
18 |    For more information about managing multiple Node.js versions, refer to this [documentation](https://docs.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows).
19 | 4. Install Monaca Localkit again.
20 | 5. The login should work now.
21 | 


--------------------------------------------------------------------------------