diff --git a/.babelrc b/.babelrc index 41789cac..13f0e471 100644 --- a/.babelrc +++ b/.babelrc @@ -1,5 +1,14 @@ { - "presets": ["es2015", "stage-2"], + "presets": [ + ["env", { "modules": false }], + "stage-2" + ], "plugins": ["transform-runtime"], - "comments": false + "comments": false, + "env": { + "test": { + "presets": ["env", "stage-2"], + "plugins": [ "istanbul" ] + } + } } diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..66dc9051 --- /dev/null +++ b/.dockerignore @@ -0,0 +1 @@ +undefined \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js index 85a83760..b3a0b5d8 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -1,15 +1,26 @@ +// http://eslint.org/docs/user-guide/configuring + module.exports = { root: true, + parser: 'babel-eslint', + parserOptions: { + sourceType: 'module' + }, + env: { + browser: true + }, // https://github.com/feross/standard/blob/master/RULES.md#javascript-standard-style extends: 'standard', // required to lint *.vue files - plugins: [ - 'html' - ], + plugins: ['html'], // add your custom rules here - 'rules': { + rules: { // allow paren-less arrow functions 'arrow-parens': 0, + // allow async-await + 'generator-star-spacing': 0, + // disable space before func paren + 'space-before-function-paren': 0, // allow debugger during development 'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0 } diff --git a/.gitignore b/.gitignore index 0a8d4284..0c97e27c 100644 --- a/.gitignore +++ b/.gitignore @@ -2,7 +2,10 @@ node_modules/ dist/ npm-debug.log +yarn-error.log test/unit/coverage test/e2e/reports selenium-debug.log .netlify +.*.dockerfile +.vs \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..afabba52 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,7 @@ +language: node_js +node_js: + - 'node' +install: + - 'npm install' +script: + - 'npm run build' \ No newline at end of file diff --git a/README.md b/README.md index 2c9a5841..073d309f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ ✈️️ Take it for a spin. + +[![Build Status](https://travis-ci.org/misterGF/CoPilot.svg?branch=master)](https://travis-ci.org/misterGF/CoPilot) +[![Build status](https://ci.appveyor.com/api/projects/status/wenct56narbt6r1l?svg=true)](https://ci.appveyor.com/project/misterGF/copilot) + !["CoPilot Screenshot"](http://res.cloudinary.com/gatec21/image/upload/v1489954238/copilot-march-2017_ifdrlj.png) In an attempt to keep the project clean I have not included every plugin/feature that AdminLTE offers. You simply need to add the plugin in the /static/js/plugin folder to include them or use npm. I've included the popular ones. diff --git a/_redirects b/_redirects new file mode 100644 index 00000000..dbda65ea --- /dev/null +++ b/_redirects @@ -0,0 +1 @@ +/* / 200 \ No newline at end of file diff --git a/appveyor.yml b/appveyor.yml new file mode 100644 index 00000000..b468e1e9 --- /dev/null +++ b/appveyor.yml @@ -0,0 +1,14 @@ +environment: + nodejs_version: "7" +install: + - ps: Install-Product node $env:nodejs_version + - npm install --loglevel=error # no warnings +test_script: + # Output useful info for debugging. + - node --version + - npm --version + # run tests + - npm run build + +# Don't actually build. +build: off \ No newline at end of file diff --git a/build/build.js b/build/build.js index 89b3d118..6b8add10 100644 --- a/build/build.js +++ b/build/build.js @@ -1,37 +1,35 @@ -/* global env:true rm:true mkdir:true cp:true */ -// https://github.com/shelljs/shelljs require('./check-versions')() -require('shelljs/global') -env.NODE_ENV = 'production' -var path = require('path') -var config = require('../config') +process.env.NODE_ENV = 'production' + var ora = require('ora') +var rm = require('rimraf') +var path = require('path') +var chalk = require('chalk') var webpack = require('webpack') +var config = require('../config') var webpackConfig = require('./webpack.prod.conf') -console.log( - ' Tip:\n' + - ' Built files are meant to be served over an HTTP server.\n' + - ' Opening index.html over file:// won\'t work.\n' -) - var spinner = ora('building for production...') spinner.start() -var assetsPath = path.join(config.build.assetsRoot, config.build.assetsSubDirectory) -rm('-rf', assetsPath) -mkdir('-p', assetsPath) -cp('-R', 'static/*', assetsPath) - -webpack(webpackConfig, function (err, stats) { - spinner.stop() +rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => { if (err) throw err - process.stdout.write(stats.toString({ - colors: true, - modules: false, - children: false, - chunks: false, - chunkModules: false - }) + '\n') + webpack(webpackConfig, function (err, stats) { + spinner.stop() + if (err) throw err + process.stdout.write(stats.toString({ + colors: true, + modules: false, + children: false, + chunks: false, + chunkModules: false + }) + '\n\n') + + console.log(chalk.cyan(' Build complete.\n')) + console.log(chalk.yellow( + ' Tip: built files are meant to be served over an HTTP server.\n' + + ' Opening index.html over file:// won\'t work.\n' + )) + }) }) diff --git a/build/check-versions.js b/build/check-versions.js index e2b6cf74..6548ba18 100644 --- a/build/check-versions.js +++ b/build/check-versions.js @@ -1,9 +1,9 @@ -var semver = require('semver') var chalk = require('chalk') +var semver = require('semver') var packageConfig = require('../package.json') -var exec = function (cmd) { - return require('child_process') - .execSync(cmd).toString().trim() + +function exec (cmd) { + return require('child_process').execSync(cmd).toString().trim() } var versionRequirements = [ diff --git a/build/dev-server.js b/build/dev-server.js index b7eeae3a..a0481699 100644 --- a/build/dev-server.js +++ b/build/dev-server.js @@ -1,10 +1,14 @@ require('./check-versions')() + var config = require('../config') -if (!process.env.NODE_ENV) process.env.NODE_ENV = config.dev.env +if (!process.env.NODE_ENV) { + process.env.NODE_ENV = JSON.parse(config.dev.env.NODE_ENV) +} + +var opn = require('opn') var path = require('path') var express = require('express') var webpack = require('webpack') -var opn = require('opn') var proxyMiddleware = require('http-proxy-middleware') var webpackConfig = process.env.NODE_ENV === 'testing' ? require('./webpack.prod.conf') @@ -12,6 +16,8 @@ var webpackConfig = process.env.NODE_ENV === 'testing' // default port where dev server listens for incoming traffic var port = process.env.PORT || config.dev.port +// automatically open browser, if not set will be false +var autoOpenBrowser = !!config.dev.autoOpenBrowser // Define HTTP proxies to your custom API backend // https://github.com/chimurai/http-proxy-middleware var proxyTable = config.dev.proxyTable @@ -21,13 +27,12 @@ var compiler = webpack(webpackConfig) var devMiddleware = require('webpack-dev-middleware')(compiler, { publicPath: webpackConfig.output.publicPath, - stats: { - colors: true, - chunks: false - } + quiet: true }) -var hotMiddleware = require('webpack-hot-middleware')(compiler) +var hotMiddleware = require('webpack-hot-middleware')(compiler, { + log: () => {} +}) // force page reload when html-webpack-plugin template changes compiler.plugin('compilation', function (compilation) { compilation.plugin('html-webpack-plugin-after-emit', function (data, cb) { @@ -42,7 +47,7 @@ Object.keys(proxyTable).forEach(function (context) { if (typeof options === 'string') { options = { target: options } } - app.use(proxyMiddleware(context, options)) + app.use(proxyMiddleware(options.filter || context, options)) }) // handle fallback for HTML5 history API @@ -59,12 +64,28 @@ app.use(hotMiddleware) var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory) app.use(staticPath, express.static('./static')) -module.exports = app.listen(port, function (err) { - if (err) { - console.log(err) - return +var uri = 'http://localhost:' + port + +var _resolve +var readyPromise = new Promise(resolve => { + _resolve = resolve +}) + +console.log('> Starting dev server...') +devMiddleware.waitUntilValid(() => { + console.log('> Listening at ' + uri + '\n') + // when env is testing, don't need open it + if (autoOpenBrowser && process.env.NODE_ENV !== 'testing') { + opn(uri) } - var uri = 'http://localhost:' + port - console.log('Listening at ' + uri + '\n') - opn(uri) + _resolve() }) + +var server = app.listen(port) + +module.exports = { + ready: readyPromise, + close: () => { + server.close() + } +} diff --git a/build/utils.js b/build/utils.js index dc3cdd01..3f2ef2a5 100644 --- a/build/utils.js +++ b/build/utils.js @@ -11,38 +11,48 @@ exports.assetsPath = function (_path) { exports.cssLoaders = function (options) { options = options || {} + + var cssLoader = { + loader: 'css-loader', + options: { + minimize: process.env.NODE_ENV === 'production', + sourceMap: options.sourceMap + } + } + // generate loader string to be used with extract text plugin - function generateLoaders (loaders) { - var sourceLoader = loaders.map(function (loader) { - var extraParamChar - if (/\?/.test(loader)) { - loader = loader.replace(/\?/, '-loader?') - extraParamChar = '&' - } else { - loader = loader + '-loader' - extraParamChar = '?' - } - return loader + (options.sourceMap ? extraParamChar + 'sourceMap' : '') - }).join('!') + function generateLoaders (loader, loaderOptions) { + var loaders = [cssLoader] + if (loader) { + loaders.push({ + loader: loader + '-loader', + options: Object.assign({}, loaderOptions, { + sourceMap: options.sourceMap + }) + }) + } // Extract CSS when that option is specified // (which is the case during production build) if (options.extract) { - return ExtractTextPlugin.extract('vue-style-loader', sourceLoader) + return ExtractTextPlugin.extract({ + use: loaders, + fallback: 'vue-style-loader' + }) } else { - return ['vue-style-loader', sourceLoader].join('!') + return ['vue-style-loader'].concat(loaders) } } // http://vuejs.github.io/vue-loader/en/configurations/extract-css.html return { - css: generateLoaders(['css']), - postcss: generateLoaders(['css']), - less: generateLoaders(['css', 'less']), - sass: generateLoaders(['css', 'sass?indentedSyntax']), - scss: generateLoaders(['css', 'sass']), - stylus: generateLoaders(['css', 'stylus']), - styl: generateLoaders(['css', 'stylus']) + css: generateLoaders(), + postcss: generateLoaders(), + less: generateLoaders('less'), + sass: generateLoaders('sass', { indentedSyntax: true }), + scss: generateLoaders('sass'), + stylus: generateLoaders('stylus'), + styl: generateLoaders('stylus') } } @@ -54,7 +64,7 @@ exports.styleLoaders = function (options) { var loader = loaders[extension] output.push({ test: new RegExp('\\.' + extension + '$'), - loader: loader + use: loader }) } return output diff --git a/build/vue-loader.conf.js b/build/vue-loader.conf.js new file mode 100644 index 00000000..7aee79ba --- /dev/null +++ b/build/vue-loader.conf.js @@ -0,0 +1,12 @@ +var utils = require('./utils') +var config = require('../config') +var isProduction = process.env.NODE_ENV === 'production' + +module.exports = { + loaders: utils.cssLoaders({ + sourceMap: isProduction + ? config.build.productionSourceMap + : config.dev.cssSourceMap, + extract: isProduction + }) +} diff --git a/build/webpack.base.conf.js b/build/webpack.base.conf.js index dc13c4f9..cd79c65d 100644 --- a/build/webpack.base.conf.js +++ b/build/webpack.base.conf.js @@ -1,14 +1,11 @@ var path = require('path') -var config = require('../config') var utils = require('./utils') -var projectRoot = path.resolve(__dirname, '../') +var config = require('../config') +var vueLoaderConfig = require('./vue-loader.conf') -var env = process.env.NODE_ENV -// check env & config/index.js to decide weither to enable CSS Sourcemaps for the -// various preprocessor loaders added to vue-loader at the end of this file -var cssSourceMapDev = (env === 'development' && config.dev.cssSourceMap) -var cssSourceMapProd = (env === 'production' && config.build.productionSourceMap) -var useCssSourceMap = cssSourceMapDev || cssSourceMapProd +function resolve (dir) { + return path.join(__dirname, '..', dir) +} module.exports = { entry: { @@ -16,55 +13,43 @@ module.exports = { }, output: { path: config.build.assetsRoot, - publicPath: process.env.NODE_ENV === 'production' ? config.build.assetsPublicPath : config.dev.assetsPublicPath, - filename: '[name].js' + filename: '[name].js', + publicPath: process.env.NODE_ENV === 'production' + ? config.build.assetsPublicPath + : config.dev.assetsPublicPath }, resolve: { - extensions: ['', '.js', '.vue'], - fallback: [path.join(__dirname, '../node_modules')], + extensions: ['.js', '.vue', '.json'], alias: { - 'vue$': 'vue/dist/vue', - 'src': path.resolve(__dirname, '../src'), - 'assets': path.resolve(__dirname, '../src/assets'), - 'components': path.resolve(__dirname, '../src/components') + 'vue$': 'vue/dist/vue.esm.js', + '@': resolve('src'), + 'utils': resolve('src/utils') } }, - resolveLoader: { - fallback: [path.join(__dirname, '../node_modules')] - }, module: { - preLoaders: [ + rules: [ { - test: /\.vue$/, - loader: 'eslint', - include: projectRoot, - exclude: /node_modules/ + test: /\.(js|vue)$/, + loader: 'eslint-loader', + enforce: "pre", + include: [resolve('src'), resolve('test')], + options: { + formatter: require('eslint-friendly-formatter') + } }, - { - test: /\.js$/, - loader: 'eslint', - include: projectRoot, - exclude: /node_modules/ - } - ], - loaders: [ { test: /\.vue$/, - loader: 'vue' + loader: 'vue-loader', + options: vueLoaderConfig }, { test: /\.js$/, - loader: 'babel', - include: projectRoot, - exclude: /node_modules/ - }, - { - test: /\.json$/, - loader: 'json' + loader: 'babel-loader', + include: [resolve('src'), resolve('test')] }, { test: /\.(png|jpe?g|gif|svg)(\?.*)?$/, - loader: 'url', + loader: 'url-loader', query: { limit: 10000, name: utils.assetsPath('img/[name].[hash:7].[ext]') @@ -72,23 +57,12 @@ module.exports = { }, { test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/, - loader: 'url', + loader: 'url-loader', query: { limit: 10000, name: utils.assetsPath('fonts/[name].[hash:7].[ext]') } } ] - }, - eslint: { - formatter: require('eslint-friendly-formatter') - }, - vue: { - loaders: utils.cssLoaders({ sourceMap: useCssSourceMap }), - postcss: [ - require('autoprefixer')({ - browsers: ['last 2 versions'] - }) - ] } } diff --git a/build/webpack.dev.conf.js b/build/webpack.dev.conf.js index 7e1a104f..654ab339 100644 --- a/build/webpack.dev.conf.js +++ b/build/webpack.dev.conf.js @@ -1,9 +1,10 @@ -var config = require('../config') +var utils = require('./utils') var webpack = require('webpack') +var config = require('../config') var merge = require('webpack-merge') -var utils = require('./utils') var baseWebpackConfig = require('./webpack.base.conf') var HtmlWebpackPlugin = require('html-webpack-plugin') +var FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin') // add hot-reload related code to entry chunks Object.keys(baseWebpackConfig.entry).forEach(function (name) { @@ -12,23 +13,25 @@ Object.keys(baseWebpackConfig.entry).forEach(function (name) { module.exports = merge(baseWebpackConfig, { module: { - loaders: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap }) + rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap }) }, - // eval-source-map is faster for development - devtool: '#eval-source-map', + // cheap-module-eval-source-map is faster for development, but chrome doesn't stop at breakpoints + // devtool: '#cheap-module-eval-source-map', + devtool: '#source-map', + plugins: [ new webpack.DefinePlugin({ 'process.env': config.dev.env }), // https://github.com/glenjamin/webpack-hot-middleware#installation--usage - new webpack.optimize.OccurenceOrderPlugin(), new webpack.HotModuleReplacementPlugin(), - new webpack.NoErrorsPlugin(), + new webpack.NoEmitOnErrorsPlugin(), // https://github.com/ampedandwired/html-webpack-plugin new HtmlWebpackPlugin({ filename: 'index.html', template: 'index.html', inject: true - }) + }), + new FriendlyErrorsPlugin() ] }) diff --git a/build/webpack.prod.conf.js b/build/webpack.prod.conf.js index 3e109bb4..5ec622a4 100644 --- a/build/webpack.prod.conf.js +++ b/build/webpack.prod.conf.js @@ -1,18 +1,24 @@ var path = require('path') -var config = require('../config') var utils = require('./utils') var webpack = require('webpack') +var config = require('../config') var merge = require('webpack-merge') var baseWebpackConfig = require('./webpack.base.conf') -var ExtractTextPlugin = require('extract-text-webpack-plugin') +var CopyWebpackPlugin = require('copy-webpack-plugin') var HtmlWebpackPlugin = require('html-webpack-plugin') +var ExtractTextPlugin = require('extract-text-webpack-plugin') +var OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin') + var env = process.env.NODE_ENV === 'testing' ? require('../config/test.env') : config.build.env var webpackConfig = merge(baseWebpackConfig, { module: { - loaders: utils.styleLoaders({ sourceMap: config.build.productionSourceMap, extract: true }) + rules: utils.styleLoaders({ + sourceMap: config.build.productionSourceMap, + extract: true + }) }, devtool: config.build.productionSourceMap ? '#source-map' : false, output: { @@ -20,12 +26,6 @@ var webpackConfig = merge(baseWebpackConfig, { filename: utils.assetsPath('js/[name].[chunkhash].js'), chunkFilename: utils.assetsPath('js/[id].[chunkhash].js') }, - vue: { - loaders: utils.cssLoaders({ - sourceMap: config.build.productionSourceMap, - extract: true - }) - }, plugins: [ // http://vuejs.github.io/vue-loader/en/workflow/production.html new webpack.DefinePlugin({ @@ -34,11 +34,20 @@ var webpackConfig = merge(baseWebpackConfig, { new webpack.optimize.UglifyJsPlugin({ compress: { warnings: false - } + }, + sourceMap: true }), - new webpack.optimize.OccurenceOrderPlugin(), // extract css into its own file - new ExtractTextPlugin(utils.assetsPath('css/[name].[contenthash].css')), + new ExtractTextPlugin({ + filename: utils.assetsPath('css/[name].[contenthash].css') + }), + // Compress extracted CSS. We are using this plugin so that possible + // duplicated CSS from different components can be deduped. + new OptimizeCSSPlugin({ + cssProcessorOptions: { + safe: true + } + }), // generate dist index.html with correct asset hash for caching. // you can customize output by editing /index.html // see https://github.com/ampedandwired/html-webpack-plugin @@ -77,7 +86,21 @@ var webpackConfig = merge(baseWebpackConfig, { new webpack.optimize.CommonsChunkPlugin({ name: 'manifest', chunks: ['vendor'] - }) + }), + // copy custom static assets + new CopyWebpackPlugin([ + { + from: path.resolve(__dirname, '../static'), + to: config.build.assetsSubDirectory, + ignore: ['.*'] + }, + // Copy redirects file + { + from: path.resolve(__dirname, '../_redirects'), + to: config.build.assetsRoot, + ignore: ['.*'] + } + ]) ] }) @@ -99,4 +122,9 @@ if (config.build.productionGzip) { ) } +if (config.build.bundleAnalyzerReport) { + var BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin + webpackConfig.plugins.push(new BundleAnalyzerPlugin()) +} + module.exports = webpackConfig diff --git a/build/webpack.test.conf.js b/build/webpack.test.conf.js new file mode 100644 index 00000000..37f98061 --- /dev/null +++ b/build/webpack.test.conf.js @@ -0,0 +1,28 @@ +// This is the webpack config used for unit tests. + +var utils = require('./utils') +var webpack = require('webpack') +var merge = require('webpack-merge') +var baseConfig = require('./webpack.base.conf') + +var webpackConfig = merge(baseConfig, { + // use inline sourcemap for karma-sourcemap-loader + module: { + rules: utils.styleLoaders() + }, + devtool: '#inline-source-map', + plugins: [ + new webpack.DefinePlugin({ + 'process.env': require('../config/test.env') + }), + new webpack.ProvidePlugin({ + $: 'jquery', + jQuery: 'jquery', + }) + ] +}) + +// no need for app entry during tests +delete webpackConfig.entry + +module.exports = webpackConfig diff --git a/index.html b/index.html index 4d76b93f..d452776c 100644 --- a/index.html +++ b/index.html @@ -22,7 +22,7 @@ - +
@@ -30,6 +30,8 @@ + + diff --git a/src/components/Dash.vue b/src/components/Dash.vue index ed44d679..aa775e1c 100644 --- a/src/components/Dash.vue +++ b/src/components/Dash.vue @@ -1,137 +1,12 @@ - diff --git a/src/components/SidebarMenu.vue b/src/components/SidebarMenu.vue deleted file mode 100644 index 641e54b9..00000000 --- a/src/components/SidebarMenu.vue +++ /dev/null @@ -1,126 +0,0 @@ - - - \ No newline at end of file diff --git a/src/components/layout/DashFooter.vue b/src/components/layout/DashFooter.vue new file mode 100644 index 00000000..cb45f9a1 --- /dev/null +++ b/src/components/layout/DashFooter.vue @@ -0,0 +1,17 @@ + + + diff --git a/src/components/layout/DashHeader.vue b/src/components/layout/DashHeader.vue new file mode 100644 index 00000000..8915bb94 --- /dev/null +++ b/src/components/layout/DashHeader.vue @@ -0,0 +1,48 @@ + + + diff --git a/src/components/layout/MessageItem.vue b/src/components/layout/MessageItem.vue new file mode 100644 index 00000000..790c7c00 --- /dev/null +++ b/src/components/layout/MessageItem.vue @@ -0,0 +1,28 @@ + + + + + diff --git a/src/components/layout/MessagesMenu.vue b/src/components/layout/MessagesMenu.vue new file mode 100644 index 00000000..b41c9d6a --- /dev/null +++ b/src/components/layout/MessagesMenu.vue @@ -0,0 +1,40 @@ + + + diff --git a/src/components/layout/NotificationItem.vue b/src/components/layout/NotificationItem.vue new file mode 100644 index 00000000..4546bdd4 --- /dev/null +++ b/src/components/layout/NotificationItem.vue @@ -0,0 +1,48 @@ + + + + + diff --git a/src/components/layout/NotificationsMenu.vue b/src/components/layout/NotificationsMenu.vue new file mode 100644 index 00000000..0f7e80d6 --- /dev/null +++ b/src/components/layout/NotificationsMenu.vue @@ -0,0 +1,115 @@ + + + + + diff --git a/src/components/Sidebar.vue b/src/components/layout/Sidebar.vue similarity index 64% rename from src/components/Sidebar.vue rename to src/components/layout/Sidebar.vue index 5347c8c2..d6829475 100644 --- a/src/components/Sidebar.vue +++ b/src/components/layout/Sidebar.vue @@ -7,11 +7,11 @@
- +
-

{{ displayName }}

+

{{user.displayName}}

Online @@ -20,16 +20,16 @@
-