├── .babelrc ├── .editorconfig ├── .electron-vue ├── build.js ├── dev-client.js ├── dev-runner.js ├── webpack.main.config.js ├── webpack.renderer.config.js └── webpack.web.config.js ├── .eslintignore ├── .eslintrc.js ├── .github └── FUNDING.yml ├── .gitignore ├── .gitmodules ├── .travis.yml ├── README.md ├── appveyor.yml ├── build └── icons │ ├── 256x256.png │ ├── icon.icns │ └── icon.ico ├── dist ├── electron │ └── .gitkeep └── web │ └── .gitkeep ├── package.json ├── src ├── index.ejs ├── main │ ├── createMenu.js │ ├── index.dev.js │ ├── index.js │ ├── listenToEvents.js │ └── registerGlobalShortcuts.js └── shared │ └── events.js ├── static └── .gitkeep └── yarn.lock /.babelrc: -------------------------------------------------------------------------------- 1 | { 2 | "comments": false, 3 | "env": { 4 | "main": { 5 | "presets": [ 6 | ["env", { 7 | "targets": { "node": 7 } 8 | }], 9 | "stage-0" 10 | ] 11 | }, 12 | "renderer": { 13 | "presets": [ 14 | ["env", { 15 | "modules": false 16 | }], 17 | "stage-0" 18 | ] 19 | }, 20 | "web": { 21 | "presets": [ 22 | ["env", { 23 | "modules": false 24 | }], 25 | "stage-0" 26 | ] 27 | } 28 | }, 29 | "plugins": ["transform-runtime"] 30 | } 31 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | [*] 2 | indent_style = space 3 | indent_size = 2 4 | insert_final_newline = true 5 | trim_trailing_whitespace = true -------------------------------------------------------------------------------- /.electron-vue/build.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | process.env.NODE_ENV = 'production' 4 | 5 | const { say } = require('cfonts') 6 | const chalk = require('chalk') 7 | const del = require('del') 8 | const { spawn } = require('child_process') 9 | const webpack = require('webpack') 10 | const Multispinner = require('multispinner') 11 | 12 | 13 | const mainConfig = require('./webpack.main.config') 14 | const rendererConfig = require('./webpack.renderer.config') 15 | const webConfig = require('./webpack.web.config') 16 | 17 | const doneLog = chalk.bgGreen.white(' DONE ') + ' ' 18 | const errorLog = chalk.bgRed.white(' ERROR ') + ' ' 19 | const okayLog = chalk.bgBlue.white(' OKAY ') + ' ' 20 | const isCI = process.env.CI || false 21 | 22 | if (process.env.BUILD_TARGET === 'clean') clean() 23 | else if (process.env.BUILD_TARGET === 'web') web() 24 | else build() 25 | 26 | function clean () { 27 | del.sync(['build/*', '!build/icons', '!build/icons/icon.*']) 28 | console.log(`\n${doneLog}\n`) 29 | process.exit() 30 | } 31 | 32 | function build () { 33 | greeting() 34 | 35 | del.sync(['dist/electron/*', '!.gitkeep']) 36 | 37 | const tasks = ['main', 'renderer'] 38 | const m = new Multispinner(tasks, { 39 | preText: 'building', 40 | postText: 'process' 41 | }) 42 | 43 | let results = '' 44 | 45 | m.on('success', () => { 46 | process.stdout.write('\x1B[2J\x1B[0f') 47 | console.log(`\n\n${results}`) 48 | console.log(`${okayLog}take it away ${chalk.yellow('`electron-builder`')}\n`) 49 | process.exit() 50 | }) 51 | 52 | pack(mainConfig).then(result => { 53 | results += result + '\n\n' 54 | m.success('main') 55 | }).catch(err => { 56 | m.error('main') 57 | console.log(`\n ${errorLog}failed to build main process`) 58 | console.error(`\n${err}\n`) 59 | process.exit(1) 60 | }) 61 | 62 | pack(rendererConfig).then(result => { 63 | results += result + '\n\n' 64 | m.success('renderer') 65 | }).catch(err => { 66 | m.error('renderer') 67 | console.log(`\n ${errorLog}failed to build renderer process`) 68 | console.error(`\n${err}\n`) 69 | process.exit(1) 70 | }) 71 | } 72 | 73 | function pack (config) { 74 | return new Promise((resolve, reject) => { 75 | webpack(config, (err, stats) => { 76 | if (err) reject(err.stack || err) 77 | else if (stats.hasErrors()) { 78 | let err = '' 79 | 80 | stats.toString({ 81 | chunks: false, 82 | colors: true 83 | }) 84 | .split(/\r?\n/) 85 | .forEach(line => { 86 | err += ` ${line}\n` 87 | }) 88 | 89 | reject(err) 90 | } else { 91 | resolve(stats.toString({ 92 | chunks: false, 93 | colors: true 94 | })) 95 | } 96 | }) 97 | }) 98 | } 99 | 100 | function web () { 101 | del.sync(['dist/web/*', '!.gitkeep']) 102 | webpack(webConfig, (err, stats) => { 103 | if (err || stats.hasErrors()) console.log(err) 104 | 105 | console.log(stats.toString({ 106 | chunks: false, 107 | colors: true 108 | })) 109 | 110 | process.exit() 111 | }) 112 | } 113 | 114 | function greeting () { 115 | const cols = process.stdout.columns 116 | let text = '' 117 | 118 | if (cols > 85) text = 'lets-build' 119 | else if (cols > 60) text = 'lets-|build' 120 | else text = false 121 | 122 | if (text && !isCI) { 123 | say(text, { 124 | colors: ['yellow'], 125 | font: 'simple3d', 126 | space: false 127 | }) 128 | } else console.log(chalk.yellow.bold('\n lets-build')) 129 | console.log() 130 | } 131 | -------------------------------------------------------------------------------- /.electron-vue/dev-client.js: -------------------------------------------------------------------------------- 1 | const hotClient = require('webpack-hot-middleware/client?noInfo=true&reload=true') 2 | 3 | hotClient.subscribe(event => { 4 | /** 5 | * Reload browser when HTMLWebpackPlugin emits a new index.html 6 | * 7 | * Currently disabled until jantimon/html-webpack-plugin#680 is resolved. 8 | * https://github.com/SimulatedGREG/electron-vue/issues/437 9 | * https://github.com/jantimon/html-webpack-plugin/issues/680 10 | */ 11 | // if (event.action === 'reload') { 12 | // window.location.reload() 13 | // } 14 | 15 | /** 16 | * Notify `mainWindow` when `main` process is compiling, 17 | * giving notice for an expected reload of the `electron` process 18 | */ 19 | if (event.action === 'compiling') { 20 | document.body.innerHTML += ` 21 | 34 | 35 |
36 | Compiling Main Process... 37 |
38 | ` 39 | } 40 | }) 41 | -------------------------------------------------------------------------------- /.electron-vue/dev-runner.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | const chalk = require('chalk') 4 | const electron = require('electron') 5 | const path = require('path') 6 | const { say } = require('cfonts') 7 | const { spawn } = require('child_process') 8 | const webpack = require('webpack') 9 | const WebpackDevServer = require('webpack-dev-server') 10 | const webpackHotMiddleware = require('webpack-hot-middleware') 11 | 12 | const mainConfig = require('./webpack.main.config') 13 | const rendererConfig = require('./webpack.renderer.config') 14 | 15 | let electronProcess = null 16 | let manualRestart = false 17 | let hotMiddleware 18 | 19 | function logStats (proc, data) { 20 | let log = '' 21 | 22 | log += chalk.yellow.bold(`┏ ${proc} Process ${new Array((19 - proc.length) + 1).join('-')}`) 23 | log += '\n\n' 24 | 25 | if (typeof data === 'object') { 26 | data.toString({ 27 | colors: true, 28 | chunks: false 29 | }).split(/\r?\n/).forEach(line => { 30 | log += ' ' + line + '\n' 31 | }) 32 | } else { 33 | log += ` ${data}\n` 34 | } 35 | 36 | log += '\n' + chalk.yellow.bold(`┗ ${new Array(28 + 1).join('-')}`) + '\n' 37 | 38 | console.log(log) 39 | } 40 | 41 | function startRenderer () { 42 | return new Promise((resolve, reject) => { 43 | rendererConfig.entry.renderer = [path.join(__dirname, 'dev-client')].concat(rendererConfig.entry.renderer) 44 | 45 | const compiler = webpack(rendererConfig) 46 | hotMiddleware = webpackHotMiddleware(compiler, { 47 | log: false, 48 | heartbeat: 2500 49 | }) 50 | 51 | compiler.plugin('compilation', compilation => { 52 | compilation.plugin('html-webpack-plugin-after-emit', (data, cb) => { 53 | hotMiddleware.publish({ action: 'reload' }) 54 | cb() 55 | }) 56 | }) 57 | 58 | compiler.plugin('done', stats => { 59 | logStats('Renderer', stats) 60 | }) 61 | 62 | const server = new WebpackDevServer( 63 | compiler, 64 | { 65 | contentBase: path.join(__dirname, '../'), 66 | quiet: true, 67 | before (app, ctx) { 68 | app.use(hotMiddleware) 69 | ctx.middleware.waitUntilValid(() => { 70 | resolve() 71 | }) 72 | } 73 | } 74 | ) 75 | 76 | server.listen(9080) 77 | }) 78 | } 79 | 80 | function startMain () { 81 | return new Promise((resolve, reject) => { 82 | mainConfig.entry.main = [path.join(__dirname, '../src/main/index.dev.js')].concat(mainConfig.entry.main) 83 | 84 | const compiler = webpack(mainConfig) 85 | 86 | compiler.plugin('watch-run', (compilation, done) => { 87 | logStats('Main', chalk.white.bold('compiling...')) 88 | hotMiddleware.publish({ action: 'compiling' }) 89 | done() 90 | }) 91 | 92 | compiler.watch({}, (err, stats) => { 93 | if (err) { 94 | console.log(err) 95 | return 96 | } 97 | 98 | logStats('Main', stats) 99 | 100 | if (electronProcess && electronProcess.kill) { 101 | manualRestart = true 102 | process.kill(electronProcess.pid) 103 | electronProcess = null 104 | startElectron() 105 | 106 | setTimeout(() => { 107 | manualRestart = false 108 | }, 5000) 109 | } 110 | 111 | resolve() 112 | }) 113 | }) 114 | } 115 | 116 | function startElectron () { 117 | electronProcess = spawn(electron, ['--inspect=5858', path.join(__dirname, '../dist/electron/main.js')]) 118 | 119 | electronProcess.stdout.on('data', data => { 120 | electronLog(data, 'blue') 121 | }) 122 | electronProcess.stderr.on('data', data => { 123 | electronLog(data, 'red') 124 | }) 125 | 126 | electronProcess.on('close', () => { 127 | if (!manualRestart) process.exit() 128 | }) 129 | } 130 | 131 | function electronLog (data, color) { 132 | let log = '' 133 | data = data.toString().split(/\r?\n/) 134 | data.forEach(line => { 135 | log += ` ${line}\n` 136 | }) 137 | if (/[0-9A-z]+/.test(log)) { 138 | console.log( 139 | chalk[color].bold('┏ Electron -------------------') + 140 | '\n\n' + 141 | log + 142 | chalk[color].bold('┗ ----------------------------') + 143 | '\n' 144 | ) 145 | } 146 | } 147 | 148 | function greeting () { 149 | const cols = process.stdout.columns 150 | let text = '' 151 | 152 | if (cols > 104) text = 'electron-vue' 153 | else if (cols > 76) text = 'electron-|vue' 154 | else text = false 155 | 156 | if (text) { 157 | say(text, { 158 | colors: ['yellow'], 159 | font: 'simple3d', 160 | space: false 161 | }) 162 | } else console.log(chalk.yellow.bold('\n electron-vue')) 163 | console.log(chalk.blue(' getting ready...') + '\n') 164 | } 165 | 166 | function init () { 167 | greeting() 168 | 169 | Promise.all([startRenderer(), startMain()]) 170 | .then(() => { 171 | startElectron() 172 | }) 173 | .catch(err => { 174 | console.error(err) 175 | }) 176 | } 177 | 178 | init() 179 | -------------------------------------------------------------------------------- /.electron-vue/webpack.main.config.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | process.env.BABEL_ENV = 'main' 4 | 5 | const path = require('path') 6 | const { dependencies } = require('../package.json') 7 | const webpack = require('webpack') 8 | 9 | const BabiliWebpackPlugin = require('babili-webpack-plugin') 10 | 11 | let mainConfig = { 12 | entry: { 13 | main: path.join(__dirname, '../src/main/index.js') 14 | }, 15 | externals: [ 16 | ...Object.keys(dependencies || {}) 17 | ], 18 | module: { 19 | rules: [ 20 | { 21 | test: /\.(js)$/, 22 | enforce: 'pre', 23 | exclude: /node_modules/, 24 | use: { 25 | loader: 'eslint-loader', 26 | options: { 27 | formatter: require('eslint-friendly-formatter') 28 | } 29 | } 30 | }, 31 | { 32 | test: /\.js$/, 33 | use: 'babel-loader', 34 | exclude: /node_modules/ 35 | }, 36 | { 37 | test: /\.node$/, 38 | use: 'node-loader' 39 | } 40 | ] 41 | }, 42 | node: { 43 | __dirname: process.env.NODE_ENV !== 'production', 44 | __filename: process.env.NODE_ENV !== 'production' 45 | }, 46 | output: { 47 | filename: '[name].js', 48 | libraryTarget: 'commonjs2', 49 | path: path.join(__dirname, '../dist/electron') 50 | }, 51 | plugins: [ 52 | new webpack.NoEmitOnErrorsPlugin() 53 | ], 54 | resolve: { 55 | extensions: ['.js', '.json', '.node'], 56 | alias: { 57 | '&': path.join(__dirname, '../src/shared') 58 | } 59 | }, 60 | target: 'electron-main' 61 | } 62 | 63 | /** 64 | * Adjust mainConfig for development settings 65 | */ 66 | if (process.env.NODE_ENV !== 'production') { 67 | mainConfig.plugins.push( 68 | new webpack.DefinePlugin({ 69 | '__static': `"${path.join(__dirname, '../static').replace(/\\/g, '\\\\')}"` 70 | }) 71 | ) 72 | } 73 | 74 | /** 75 | * Adjust mainConfig for production settings 76 | */ 77 | if (process.env.NODE_ENV === 'production') { 78 | mainConfig.plugins.push( 79 | new BabiliWebpackPlugin(), 80 | new webpack.DefinePlugin({ 81 | 'process.env.NODE_ENV': '"production"' 82 | }) 83 | ) 84 | } 85 | 86 | module.exports = mainConfig 87 | -------------------------------------------------------------------------------- /.electron-vue/webpack.renderer.config.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | process.env.BABEL_ENV = 'renderer' 4 | 5 | const path = require('path') 6 | const { dependencies } = require('../package.json') 7 | const webpack = require('webpack') 8 | 9 | const BabiliWebpackPlugin = require('babili-webpack-plugin') 10 | const CopyWebpackPlugin = require('copy-webpack-plugin') 11 | const ExtractTextPlugin = require('extract-text-webpack-plugin') 12 | const HtmlWebpackPlugin = require('html-webpack-plugin') 13 | 14 | /** 15 | * List of node_modules to include in webpack bundle 16 | * 17 | * Required for specific packages like Vue UI libraries 18 | * that provide pure *.vue files that need compiling 19 | * https://simulatedgreg.gitbooks.io/electron-vue/content/en/webpack-configurations.html#white-listing-externals 20 | */ 21 | let whiteListedModules = ['vue'] 22 | 23 | let rendererConfig = { 24 | devtool: '#cheap-module-eval-source-map', 25 | entry: { 26 | renderer: path.join(__dirname, '../src/renderer/js/app.js') 27 | }, 28 | externals: [ 29 | ...Object.keys(dependencies || {}).filter(d => !whiteListedModules.includes(d)) 30 | ], 31 | module: { 32 | rules: [ 33 | { 34 | test: /\.(js|vue)$/, 35 | enforce: 'pre', 36 | exclude: /node_modules/, 37 | use: { 38 | loader: 'eslint-loader', 39 | options: { 40 | formatter: require('eslint-friendly-formatter') 41 | } 42 | } 43 | }, 44 | { 45 | test: /\.css$/, 46 | use: ExtractTextPlugin.extract({ 47 | fallback: 'style-loader', 48 | use: 'css-loader' 49 | }) 50 | }, 51 | { 52 | test: /\.html$/, 53 | use: 'vue-html-loader' 54 | }, 55 | { 56 | test: /\.js$/, 57 | use: 'babel-loader', 58 | exclude: /node_modules/ 59 | }, 60 | { 61 | test: /\.node$/, 62 | use: 'node-loader' 63 | }, 64 | { 65 | test: /\.vue$/, 66 | use: { 67 | loader: 'vue-loader', 68 | options: { 69 | extractCSS: process.env.NODE_ENV === 'production', 70 | loaders: { 71 | sass: 'vue-style-loader!css-loader!sass-loader?indentedSyntax=1', 72 | scss: 'vue-style-loader!css-loader!sass-loader' 73 | } 74 | } 75 | } 76 | }, 77 | { 78 | test: /\.scss$/, 79 | use: { 80 | loader: 'sass-loader' 81 | } 82 | }, 83 | { 84 | test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, 85 | use: { 86 | loader: 'url-loader', 87 | query: { 88 | limit: 10000, 89 | name: 'imgs/[name]--[folder].[ext]' 90 | } 91 | } 92 | }, 93 | { 94 | test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/, 95 | loader: 'url-loader', 96 | options: { 97 | limit: 10000, 98 | name: 'media/[name]--[folder].[ext]' 99 | } 100 | }, 101 | { 102 | test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, 103 | use: { 104 | loader: 'url-loader', 105 | query: { 106 | limit: 10000, 107 | name: 'fonts/[name]--[folder].[ext]' 108 | } 109 | } 110 | } 111 | ] 112 | }, 113 | node: { 114 | __dirname: process.env.NODE_ENV !== 'production', 115 | __filename: process.env.NODE_ENV !== 'production' 116 | }, 117 | plugins: [ 118 | new ExtractTextPlugin('styles.css'), 119 | new HtmlWebpackPlugin({ 120 | filename: 'index.html', 121 | template: path.resolve(__dirname, '../src/index.ejs'), 122 | minify: { 123 | collapseWhitespace: true, 124 | removeAttributeQuotes: true, 125 | removeComments: true 126 | }, 127 | nodeModules: process.env.NODE_ENV !== 'production' 128 | ? path.resolve(__dirname, '../node_modules') 129 | : false 130 | }), 131 | new webpack.DefinePlugin({ 132 | KOEL_ENV: '"app"', 133 | NODE_ENV: JSON.stringify(process.env.NODE_ENV || 'development') 134 | }), 135 | new webpack.HotModuleReplacementPlugin(), 136 | new webpack.NoEmitOnErrorsPlugin() 137 | ], 138 | output: { 139 | filename: '[name].js', 140 | libraryTarget: 'commonjs2', 141 | path: path.join(__dirname, '../dist/electron') 142 | }, 143 | resolve: { 144 | alias: { 145 | '@': path.join(__dirname, '../src/renderer/js'), 146 | '#': path.join(__dirname, '../src/renderer/sass'), 147 | '&': path.join(__dirname, '../src/shared'), 148 | 'vue$': 'vue/dist/vue.esm.js' 149 | }, 150 | extensions: ['.js', '.vue', '.json', '.css', '.node'] 151 | }, 152 | target: 'electron-renderer' 153 | } 154 | 155 | /** 156 | * Adjust rendererConfig for development settings 157 | */ 158 | if (process.env.NODE_ENV !== 'production') { 159 | rendererConfig.plugins.push( 160 | new webpack.DefinePlugin({ 161 | '__static': `"${path.join(__dirname, '../static').replace(/\\/g, '\\\\')}"` 162 | }) 163 | ) 164 | } 165 | 166 | /** 167 | * Adjust rendererConfig for production settings 168 | */ 169 | if (process.env.NODE_ENV === 'production') { 170 | rendererConfig.devtool = '' 171 | 172 | rendererConfig.plugins.push( 173 | new BabiliWebpackPlugin(), 174 | new CopyWebpackPlugin([ 175 | { 176 | from: path.join(__dirname, '../static'), 177 | to: path.join(__dirname, '../dist/electron/static'), 178 | ignore: ['.*'] 179 | } 180 | ]), 181 | new webpack.DefinePlugin({ 182 | 'process.env.NODE_ENV': '"production"' 183 | }), 184 | new webpack.LoaderOptionsPlugin({ 185 | minimize: true 186 | }) 187 | ) 188 | } 189 | 190 | module.exports = rendererConfig 191 | -------------------------------------------------------------------------------- /.electron-vue/webpack.web.config.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | process.env.BABEL_ENV = 'web' 4 | 5 | const path = require('path') 6 | const webpack = require('webpack') 7 | 8 | const BabiliWebpackPlugin = require('babili-webpack-plugin') 9 | const CopyWebpackPlugin = require('copy-webpack-plugin') 10 | const ExtractTextPlugin = require('extract-text-webpack-plugin') 11 | const HtmlWebpackPlugin = require('html-webpack-plugin') 12 | 13 | let webConfig = { 14 | devtool: '#cheap-module-eval-source-map', 15 | entry: { 16 | web: path.join(__dirname, '../src/renderer/main.js') 17 | }, 18 | module: { 19 | rules: [ 20 | { 21 | test: /\.(js|vue)$/, 22 | enforce: 'pre', 23 | exclude: /node_modules/, 24 | use: { 25 | loader: 'eslint-loader', 26 | options: { 27 | formatter: require('eslint-friendly-formatter') 28 | } 29 | } 30 | }, 31 | { 32 | test: /\.css$/, 33 | use: ExtractTextPlugin.extract({ 34 | fallback: 'style-loader', 35 | use: 'css-loader' 36 | }) 37 | }, 38 | { 39 | test: /\.html$/, 40 | use: 'vue-html-loader' 41 | }, 42 | { 43 | test: /\.js$/, 44 | use: 'babel-loader', 45 | include: [ path.resolve(__dirname, '../src/renderer') ], 46 | exclude: /node_modules/ 47 | }, 48 | { 49 | test: /\.vue$/, 50 | use: { 51 | loader: 'vue-loader', 52 | options: { 53 | extractCSS: true, 54 | loaders: { 55 | sass: 'vue-style-loader!css-loader!sass-loader?indentedSyntax=1', 56 | scss: 'vue-style-loader!css-loader!sass-loader' 57 | } 58 | } 59 | } 60 | }, 61 | { 62 | test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, 63 | use: { 64 | loader: 'url-loader', 65 | query: { 66 | limit: 10000, 67 | name: 'imgs/[name].[ext]' 68 | } 69 | } 70 | }, 71 | { 72 | test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, 73 | use: { 74 | loader: 'url-loader', 75 | query: { 76 | limit: 10000, 77 | name: 'fonts/[name].[ext]' 78 | } 79 | } 80 | } 81 | ] 82 | }, 83 | plugins: [ 84 | new ExtractTextPlugin('styles.css'), 85 | new HtmlWebpackPlugin({ 86 | filename: 'index.html', 87 | template: path.resolve(__dirname, '../src/index.ejs'), 88 | minify: { 89 | collapseWhitespace: true, 90 | removeAttributeQuotes: true, 91 | removeComments: true 92 | }, 93 | nodeModules: false 94 | }), 95 | new webpack.DefinePlugin({ 96 | 'process.env.IS_WEB': 'true' 97 | }), 98 | new webpack.HotModuleReplacementPlugin(), 99 | new webpack.NoEmitOnErrorsPlugin() 100 | ], 101 | output: { 102 | filename: '[name].js', 103 | path: path.join(__dirname, '../dist/web') 104 | }, 105 | resolve: { 106 | alias: { 107 | '@': path.join(__dirname, '../src/renderer'), 108 | 'vue$': 'vue/dist/vue.esm.js' 109 | }, 110 | extensions: ['.js', '.vue', '.json', '.css'] 111 | }, 112 | target: 'web' 113 | } 114 | 115 | /** 116 | * Adjust webConfig for production settings 117 | */ 118 | if (process.env.NODE_ENV === 'production') { 119 | webConfig.devtool = '' 120 | 121 | webConfig.plugins.push( 122 | new BabiliWebpackPlugin(), 123 | new CopyWebpackPlugin([ 124 | { 125 | from: path.join(__dirname, '../static'), 126 | to: path.join(__dirname, '../dist/web/static'), 127 | ignore: ['.*'] 128 | } 129 | ]), 130 | new webpack.DefinePlugin({ 131 | 'process.env.NODE_ENV': '"production"' 132 | }), 133 | new webpack.LoaderOptionsPlugin({ 134 | minimize: true 135 | }) 136 | ) 137 | } 138 | 139 | module.exports = webConfig 140 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | /src/renderer/js/libs 3 | /src/renderer/js/tests/__coverage__ 4 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | root: true, 3 | parser: 'babel-eslint', 4 | parserOptions: { 5 | sourceType: 'module' 6 | }, 7 | env: { 8 | browser: true, 9 | node: true 10 | }, 11 | extends: 'vue', 12 | globals: { 13 | __static: true, 14 | KOEL_ENV: true, 15 | NODE_ENV: true 16 | }, 17 | plugins: [ 18 | 'html' 19 | ], 20 | 'rules': { 21 | // allow paren-less arrow functions 22 | 'arrow-parens': 0, 23 | // allow async-await 24 | 'generator-star-spacing': 0, 25 | // allow debugger during development 26 | 'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0, 27 | 'no-multi-str': 0, 28 | 'standard/object-curly-even-spacing': 0, 29 | 'no-useless-escape': 0, 30 | 'no-new': 0 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [phanan] 4 | open_collective: koel 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | dist/electron/* 3 | dist/web/* 4 | build/* 5 | !build/icons 6 | node_modules/ 7 | npm-debug.log 8 | npm-debug.log.* 9 | thumbs.db 10 | !.gitkeep 11 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "src/renderer"] 2 | path = src/renderer 3 | url = https://github.com/koel/core.git 4 | branch = master 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | osx_image: xcode8.3 2 | sudo: required 3 | dist: trusty 4 | language: c 5 | matrix: 6 | include: 7 | - os: osx 8 | - os: linux 9 | env: CC=clang CXX=clang++ npm_config_clang=1 10 | compiler: clang 11 | cache: 12 | directories: 13 | - node_modules 14 | - "$HOME/.electron" 15 | - "$HOME/.cache" 16 | addons: 17 | apt: 18 | packages: 19 | - libgnome-keyring-dev 20 | - icnsutils 21 | before_install: 22 | - mkdir -p /tmp/git-lfs && curl -L https://github.com/github/git-lfs/releases/download/v1.2.1/git-lfs-$([ 23 | "$TRAVIS_OS_NAME" == "linux" ] && echo "linux" || echo "darwin")-amd64-1.2.1.tar.gz 24 | | tar -xz -C /tmp/git-lfs --strip-components 1 && /tmp/git-lfs/git-lfs pull 25 | - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install --no-install-recommends -y icnsutils graphicsmagick xz-utils; fi 26 | install: 27 | - nvm install 7 28 | - curl -o- -L https://yarnpkg.com/install.sh | bash 29 | - source ~/.bashrc 30 | - npm install -g xvfb-maybe 31 | - yarn 32 | script: 33 | - yarn run build 34 | branches: 35 | only: 36 | - master 37 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | koel app 2 | ============== 3 | 4 | The official desktop application for [Koel](https://github.com/phanan/koel), built on [Electron](http://electron.atom.io/). 5 | 6 | The app will inherit all features from its web-based counterpart, plus functionalities only possible in a desktop environment, e.g. lower-level OS interactions like global media shortcuts. Basically, the best of both worlds. 7 | 8 | ## Installation 9 | 10 | ```bash 11 | git clone --recursive https://github.com/phanan/koel-app.git 12 | cd koel-app 13 | yarn 14 | yarn dev # for development 15 | yarn build # for a cool app 16 | ``` 17 | 18 | The project got its boilerplate from [electron-vue](https://github.com/SimulatedGREG/electron-vue) with some modifications, so head there for in-depth instructions. 19 | 20 | ## Notes 21 | 22 | * Only tested on macOS High Siera so far, since that's the only OS I have. -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | version: 0.1.{build} 2 | 3 | branches: 4 | only: 5 | - master 6 | 7 | image: Visual Studio 2017 8 | platform: 9 | - x64 10 | 11 | cache: 12 | - node_modules 13 | - '%APPDATA%\npm-cache' 14 | - '%USERPROFILE%\.electron' 15 | - '%USERPROFILE%\AppData\Local\Yarn\cache' 16 | 17 | init: 18 | - git config --global core.autocrlf input 19 | 20 | install: 21 | - ps: Install-Product node 8 x64 22 | - choco install yarn --ignore-dependencies 23 | - git reset --hard HEAD 24 | - yarn 25 | - node --version 26 | 27 | build_script: 28 | - yarn build 29 | 30 | test: off 31 | -------------------------------------------------------------------------------- /build/icons/256x256.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/koel/app/433201cf3f34c30c3f6970b2bb5519b0e7bf14ac/build/icons/256x256.png -------------------------------------------------------------------------------- /build/icons/icon.icns: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/koel/app/433201cf3f34c30c3f6970b2bb5519b0e7bf14ac/build/icons/icon.icns -------------------------------------------------------------------------------- /build/icons/icon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/koel/app/433201cf3f34c30c3f6970b2bb5519b0e7bf14ac/build/icons/icon.ico -------------------------------------------------------------------------------- /dist/electron/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/koel/app/433201cf3f34c30c3f6970b2bb5519b0e7bf14ac/dist/electron/.gitkeep -------------------------------------------------------------------------------- /dist/web/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/koel/app/433201cf3f34c30c3f6970b2bb5519b0e7bf14ac/dist/web/.gitkeep -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "koel-app", 3 | "version": "0.0.0", 4 | "author": "Phan An ", 5 | "description": "Desktop application for Koel", 6 | "license": "MIT", 7 | "main": "./dist/electron/main.js", 8 | "scripts": { 9 | "build": "node .electron-vue/build.js && electron-builder", 10 | "build:dir": "node .electron-vue/build.js && electron-builder --dir", 11 | "build:clean": "cross-env BUILD_TARGET=clean node .electron-vue/build.js", 12 | "build:web": "cross-env BUILD_TARGET=web node .electron-vue/build.js", 13 | "dev": "node .electron-vue/dev-runner.js", 14 | "lint": "eslint --ext .js,.vue -f ./node_modules/eslint-friendly-formatter src", 15 | "lint:fix": "eslint --ext .js,.vue -f ./node_modules/eslint-friendly-formatter --fix src", 16 | "pack": "npm run pack:main && npm run pack:renderer", 17 | "pack:main": "cross-env NODE_ENV=production webpack --progress --colors --config .electron-vue/webpack.main.config.js", 18 | "pack:renderer": "cross-env NODE_ENV=production webpack --progress --colors --config .electron-vue/webpack.renderer.config.js", 19 | "postinstall": "npm run lint:fix" 20 | }, 21 | "build": { 22 | "productName": "Koel", 23 | "appId": "org.phanan.koel", 24 | "directories": { 25 | "output": "build" 26 | }, 27 | "files": [ 28 | "dist/electron/**/*" 29 | ], 30 | "dmg": { 31 | "contents": [ 32 | { 33 | "x": 410, 34 | "y": 150, 35 | "type": "link", 36 | "path": "/Applications" 37 | }, 38 | { 39 | "x": 130, 40 | "y": 150, 41 | "type": "file" 42 | } 43 | ] 44 | }, 45 | "mac": { 46 | "icon": "build/icons/icon.icns" 47 | }, 48 | "win": { 49 | "icon": "build/icons/icon.ico" 50 | }, 51 | "linux": { 52 | "icon": "build/icons" 53 | } 54 | }, 55 | "dependencies": { 56 | "@phanan/vuebus": "phanan/vuebus", 57 | "alertify.js": "^1.0.12", 58 | "axios": "^0.18.1", 59 | "blueimp-md5": "^2.3.0", 60 | "electron-dl": "^1.11.0", 61 | "intersection-observer": "^0.2.0", 62 | "ismobilejs": "^0.4.0", 63 | "local-storage": "^1.4.2", 64 | "lodash": "^4.17.13", 65 | "nouislider": "^14.0.2", 66 | "nprogress": "^0.2.0", 67 | "plyr": "1.5.x", 68 | "select": "^1.0.6", 69 | "sketch-js": "^1.1.3", 70 | "slugify": "^1.0.2", 71 | "vue": "^2.5.0", 72 | "vue-electron": "^1.0.6", 73 | "vue-global-events": "^1.0.2", 74 | "vue-virtual-scroller": "^0.5.0", 75 | "vuequery": "^1.0.0", 76 | "youtube-player": "^3.0.4" 77 | }, 78 | "devDependencies": { 79 | "babel-core": "^6.25.0", 80 | "babel-eslint": "^7.2.3", 81 | "babel-loader": "^7.1.1", 82 | "babel-plugin-transform-runtime": "^6.23.0", 83 | "babel-polyfill": "^6.26.0", 84 | "babel-preset-env": "^1.6.0", 85 | "babel-preset-es2015": "^6.24.1", 86 | "babel-preset-stage-0": "^6.24.1", 87 | "babel-register": "^6.24.1", 88 | "babili-webpack-plugin": "^0.1.2", 89 | "cfonts": "^1.1.3", 90 | "chalk": "^2.1.0", 91 | "copy-webpack-plugin": "^4.0.1", 92 | "cross-env": "^5.0.5", 93 | "css-loader": "^0.28.4", 94 | "del": "^3.0.0", 95 | "devtron": "^1.4.0", 96 | "electron": "^1.8.8", 97 | "electron-builder": "^19.19.1", 98 | "electron-debug": "^1.4.0", 99 | "electron-devtools-installer": "^2.2.0", 100 | "electron-window-state": "^4.1.1", 101 | "eslint": "^4.18.2", 102 | "eslint-config-vue": "^2.0.2", 103 | "eslint-friendly-formatter": "^3.0.0", 104 | "eslint-loader": "^1.9.0", 105 | "eslint-plugin-html": "^3.1.1", 106 | "eslint-plugin-import": "^2.7.0", 107 | "eslint-plugin-jest": "^22.1.2", 108 | "eslint-plugin-node": "^5.1.1", 109 | "eslint-plugin-prettier": "^3.0.0", 110 | "eslint-plugin-promise": "^3.5.0", 111 | "eslint-plugin-standard": "^3.0.1", 112 | "eslint-plugin-vue": "^4.2.2", 113 | "extract-text-webpack-plugin": "^3.0.0", 114 | "file-loader": "^0.11.2", 115 | "font-awesome": "^4.7.0", 116 | "html-webpack-plugin": "^2.30.1", 117 | "multispinner": "^0.2.1", 118 | "node-loader": "^0.6.0", 119 | "node-sass": "^4.11.0", 120 | "pusher-js": "^4.2.2", 121 | "sass-loader": "^6.0.6", 122 | "style-loader": "^0.18.2", 123 | "url-loader": "^0.5.9", 124 | "vue-html-loader": "^1.2.4", 125 | "vue-loader": "^13.0.5", 126 | "vue-style-loader": "^3.0.1", 127 | "vue-template-compiler": "^2.4.2", 128 | "webpack": "^3.5.2", 129 | "webpack-dev-server": "^3.1.11", 130 | "webpack-hot-middleware": "^2.18.2" 131 | } 132 | } 133 | -------------------------------------------------------------------------------- /src/index.ejs: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Koel 6 | <% if (htmlWebpackPlugin.options.nodeModules) { %> 7 | 8 | 11 | <% } %> 12 | 13 | 14 |
15 | 16 | 19 | 20 | 21 | 22 | 23 | -------------------------------------------------------------------------------- /src/main/createMenu.js: -------------------------------------------------------------------------------- 1 | import { app, BrowserWindow, Menu } from 'electron' 2 | 3 | export default win => { 4 | const menuTemplate = [ 5 | { 6 | label: 'Application', 7 | submenu: [ 8 | { label: 'Reload', accelerator: 'CmdOrCtrl+R', click: () => win.reload() }, 9 | { label: 'About Koel', click: () => win.webContents.send('cmd', 'ShowAboutPanel') }, 10 | { type: 'separator' }, 11 | { label: 'Quit', accelerator: 'Command+Q', click: () => app.quit() } 12 | ] 13 | }, { 14 | label: 'Edit', 15 | submenu: [ 16 | { label: 'Undo', accelerator: 'CmdOrCtrl+Z', selector: 'undo:' }, 17 | { label: 'Redo', accelerator: 'Shift+CmdOrCtrl+Z', selector: 'redo:' }, 18 | { type: 'separator' }, 19 | { label: 'Cut', accelerator: 'CmdOrCtrl+X', selector: 'cut:' }, 20 | { label: 'Copy', accelerator: 'CmdOrCtrl+C', selector: 'copy:' }, 21 | { label: 'Paste', accelerator: 'CmdOrCtrl+V', selector: 'paste:' }, 22 | { label: 'Select All', accelerator: 'CmdOrCtrl+A', selector: 'selectAll:' } 23 | ] 24 | } 25 | ] 26 | 27 | if (process.env.NODE_ENV === 'development') { 28 | menuTemplate.push({ 29 | label: 'Development', 30 | submenu: [ 31 | { 32 | label: 'Toggle DevTools', 33 | accelerator: 'Alt+CmdOrCtrl+I', 34 | click: () => BrowserWindow.getFocusedWindow().toggleDevTools() 35 | } 36 | ] 37 | }) 38 | 39 | win.openDevTools() 40 | } 41 | 42 | Menu.setApplicationMenu(Menu.buildFromTemplate(menuTemplate)) 43 | } 44 | -------------------------------------------------------------------------------- /src/main/index.dev.js: -------------------------------------------------------------------------------- 1 | /** 2 | * This file is used specifically and only for development. It installs 3 | * `electron-debug` & `vue-devtools`. There shouldn't be any need to 4 | * modify this file, but it can be used to extend your development 5 | * environment. 6 | */ 7 | 8 | /* eslint-disable */ 9 | 10 | // Set environment for development 11 | process.env.NODE_ENV = 'development' 12 | 13 | // Install `electron-debug` with `devtron` 14 | require('electron-debug')({ showDevTools: true }) 15 | 16 | // Install `vue-devtools` 17 | require('electron').app.on('ready', () => { 18 | let installExtension = require('electron-devtools-installer') 19 | installExtension.default(installExtension.VUEJS_DEVTOOLS) 20 | .then(() => {}) 21 | .catch(err => { 22 | console.log('Unable to install `vue-devtools`: \n', err) 23 | }) 24 | }) 25 | 26 | // Require `main` process to boot app 27 | require('./index') 28 | -------------------------------------------------------------------------------- /src/main/index.js: -------------------------------------------------------------------------------- 1 | 'use strict' 2 | 3 | import { app, BrowserWindow, globalShortcut } from 'electron' 4 | import windowStateKeeper from 'electron-window-state' 5 | import createMenu from './createMenu' 6 | import registerGlobalShortcuts from './registerGlobalShortcuts' 7 | import listenToEvents from './listenToEvents' 8 | 9 | const MIN_WINDOW_WIDTH = 1280 10 | const MIN_WINDOW_HEIGHT = 640 11 | 12 | /** 13 | * Set `__static` path to static files in production 14 | * https://simulatedgreg.gitbooks.io/electron-vue/content/en/using-static-assets.html 15 | */ 16 | if (process.env.NODE_ENV !== 'development') { 17 | global.__static = require('path').join(__dirname, '/static').replace(/\\/g, '\\\\') 18 | } 19 | 20 | let mainWindow 21 | const winURL = process.env.NODE_ENV === 'development' 22 | ? `http://localhost:9080` 23 | : `file://${__dirname}/index.html` 24 | 25 | const createWindow = () => { 26 | const mainWindowState = windowStateKeeper({ 27 | defaultWith: MIN_WINDOW_WIDTH, 28 | defaultHeight: MIN_WINDOW_HEIGHT 29 | }) 30 | /** 31 | * Initial window options 32 | */ 33 | mainWindow = new BrowserWindow({ 34 | x: mainWindowState.x, 35 | y: mainWindowState.y, 36 | width: mainWindowState.width < MIN_WINDOW_WIDTH ? MIN_WINDOW_WIDTH : mainWindowState.width, 37 | height: mainWindowState.height < MIN_WINDOW_HEIGHT ? MIN_WINDOW_HEIGHT : mainWindowState.height, 38 | fullscreenable: false, 39 | titleBarStyle: 'hiddenInset', 40 | minHeight: MIN_WINDOW_HEIGHT, 41 | minWidth: MIN_WINDOW_WIDTH, 42 | autoHideMenuBar: true, 43 | darkTheme: true, 44 | show: false, 45 | backgroundColor: '#181818' 46 | }) 47 | 48 | mainWindow.once('ready-to-show', () => mainWindow.show()) 49 | 50 | if (mainWindowState.isMaximized) { 51 | mainWindow.maximize() 52 | } 53 | 54 | mainWindowState.manage(mainWindow) 55 | 56 | mainWindow.loadURL(winURL) 57 | 58 | mainWindow.on('closed', () => { 59 | mainWindow = null 60 | }) 61 | } 62 | 63 | app.on('ready', () => { 64 | createWindow() 65 | createMenu(mainWindow) 66 | registerGlobalShortcuts(mainWindow) 67 | listenToEvents() 68 | }) 69 | 70 | app.on('window-all-closed', () => { 71 | if (process.platform !== 'darwin') { 72 | app.quit() 73 | } 74 | }) 75 | 76 | app.on('activate', () => { 77 | if (mainWindow === null) { 78 | createWindow() 79 | } 80 | }) 81 | 82 | app.on('will-quit', () => globalShortcut.unregisterAll()) 83 | 84 | /** 85 | * Auto Updater 86 | * 87 | * Uncomment the following code below and install `electron-updater` to 88 | * support auto updating. Code Signing with a valid certificate is required. 89 | * https://simulatedgreg.gitbooks.io/electron-vue/content/en/using-electron-builder.html#auto-updating 90 | */ 91 | 92 | /* 93 | import { autoUpdater } from 'electron-updater' 94 | 95 | autoUpdater.on('update-downloaded', () => { 96 | autoUpdater.quitAndInstall() 97 | }) 98 | 99 | app.on('ready', () => { 100 | if (process.env.NODE_ENV === 'production') autoUpdater.checkForUpdates() 101 | }) 102 | */ 103 | -------------------------------------------------------------------------------- /src/main/listenToEvents.js: -------------------------------------------------------------------------------- 1 | import { ipcMain, BrowserWindow } from 'electron' 2 | import { download } from 'electron-dl' 3 | import events from '&/events' 4 | 5 | export default function () { 6 | ipcMain.on(events.DOWNLOAD, (e, url) => { 7 | download(BrowserWindow.getFocusedWindow(), url, { 8 | openFolderWhenDone: true 9 | }) 10 | }) 11 | } 12 | -------------------------------------------------------------------------------- /src/main/registerGlobalShortcuts.js: -------------------------------------------------------------------------------- 1 | import { globalShortcut } from 'electron' 2 | import events from '&/events' 3 | 4 | export default win => { 5 | const shortcuts = ['MediaNextTrack', 'MediaPreviousTrack', 'MediaStop', 'MediaPlayPause'] 6 | 7 | shortcuts.forEach(key => { 8 | globalShortcut.register(key, () => win.webContents.send(events.GLOBAL_SHORTCUT, key)) 9 | }) 10 | } 11 | -------------------------------------------------------------------------------- /src/shared/events.js: -------------------------------------------------------------------------------- 1 | export default { 2 | DOWNLOAD: 'DOWNLOAD', 3 | SHOW_ABOUT_PANEL: 'SHOW_ABOUT_PANEL', 4 | GLOBAL_SHORTCUT: 'GLOBAL_SHORTCUT' 5 | } 6 | -------------------------------------------------------------------------------- /static/.gitkeep: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/koel/app/433201cf3f34c30c3f6970b2bb5519b0e7bf14ac/static/.gitkeep --------------------------------------------------------------------------------