Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommoor/electron-lets-move
Automatically move Electron apps to the Applications directory
https://github.com/tommoor/electron-lets-move
electron macos
Last synced: about 2 months ago
JSON representation
Automatically move Electron apps to the Applications directory
- Host: GitHub
- URL: https://github.com/tommoor/electron-lets-move
- Owner: tommoor
- Archived: true
- Created: 2016-12-11T01:58:20.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-11-29T23:41:14.000Z (almost 7 years ago)
- Last Synced: 2024-04-13T07:31:13.613Z (5 months ago)
- Topics: electron, macos
- Language: JavaScript
- Size: 13.7 KB
- Stars: 178
- Watchers: 5
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
**This functionality is now baked into Electron and the project is archived. I suggest using the [new native API](https://github.com/electron/electron/blob/c0e9dbcc0081aec773016cd08a759929536aaae4/docs/api/app.md#appisinapplicationsfolder-macos).**
[](https://badge.fury.io/js/electron-lets-move)
# Electron LetsMove
A module that offers to automatically move your Electron app to the Applications
folder if opened from another location. Inspired by [LetsMove](https://github.com/potionfactory/LetsMove) for MacOS.
## Requirements
This module is designed to be used within Electron on macOS, it can be included in a cross platform Electron app and is a no-op on the Windows and Linux platforms.
## Installation
`npm install --save electron-lets-move`
## Usage
You should call the `moveToApplications` method as soon as possible after the app
ready event in the main process. Ideally before the user has any chance to interact
with the application.
`moveToApplications` returns a promise that will resolve when the application is
in the correct location, the user asked not to move or an error occurred. You can
also provide an optional node-style callback as the only parameter.
### ES5
```javascript
const {app} = require('electron');
const {moveToApplications} = require('electron-lets-move');
app.on('ready', function() {
moveToApplications(function(err, moved) {
if (err) {
// log error, something went wrong whilst moving the app.
}
if (!moved) {
// the user asked not to move the app, it's up to the parent application
// to store this information and not hassle them again.
}
// do the rest of your application startup
});
});
```
### ES6
```javascript
import {app} from 'electron';
import {moveToApplications} from 'electron-lets-move';
app.on('ready', async () => {
try {
const moved = await moveToApplications();
if (!moved) {
// the user asked not to move the app, it's up to the parent application
// to store this information and not hassle them again.
}
} catch (err) {
// log error, something went wrong whilst moving the app.
}
// do the rest of your application startup
});
```
## License
Electron LetsMove is released under the MIT license. It is simple and easy to understand and places almost no restrictions on what you can do with it.
[More Information](http://en.wikipedia.org/wiki/MIT_License)