1
0
mirror of https://github.com/Decicus/DecAPI-Docs.git synced 2024-11-21 20:42:29 +01:00

[Dependencies] Upgrade and fix broken dependencies

[Cleanup] Partial refactor and cleanup
This commit is contained in:
Alex Thomassen 2020-04-30 13:56:37 +02:00
parent e00d012127
commit e777898023
Signed by: Alex
GPG Key ID: 10BD786B5F6FF5DE
54 changed files with 7136 additions and 8386 deletions

View File

@ -1,13 +0,0 @@
{
"presets": [
["env", { "modules": false }],
"stage-2"
],
"plugins": ["transform-runtime"],
"env": {
"test": {
"presets": ["env", "stage-2"],
"plugins": [ "istanbul" ]
}
}
}

3
.browserslistrc Normal file
View File

@ -0,0 +1,3 @@
> 1%
last 2 versions
not dead

View File

@ -1,44 +1,19 @@
// http://eslint.org/docs/user-guide/configuring
module.exports = {
root: true,
parser: 'babel-eslint',
parserOptions: {
sourceType: 'module'
},
env: {
browser: true,
},
extends: 'airbnb-base',
// required to lint *.vue files
plugins: [
'html'
],
// check if imports actually resolve
'settings': {
'import/resolver': {
'webpack': {
'config': 'build/webpack.base.conf.js'
}
root: true,
env: {
node: true
},
extends: ["plugin:vue/essential", "@vue/airbnb"],
parserOptions: {
parser: "babel-eslint"
},
rules: {
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
indent: ["error", 4],
'max-len': ['error', {
code: 250,
ignoreUrls: true,
}],
}
},
// add your custom rules here
'rules': {
'arrow-body-style': ['error', 'always'],
'indent': ['error', 4],
'no-param-reassign': [2, {
"props": false,
}],
// don't require .vue extension when importing
'import/extensions': ['error', 'always', {
'js': 'never',
'vue': 'never'
}],
// allow optionalDependencies
'import/no-extraneous-dependencies': ['error', {
'optionalDependencies': ['test/unit/index.js']
}],
// allow debugger during development
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0
}
}
};

8
.gitattributes vendored
View File

@ -1,5 +1,5 @@
*.html text eol=lf
*.js text eol=lf
*.yaml text eol=lf
*.vue text eol=lf
*.html text eol=lf
*.js text eol=lf
*.yaml text eol=lf
*.vue text eol=lf
*.json text eol=lf

19
.gitignore vendored
View File

@ -1,6 +1,21 @@
.DS_Store
node_modules/
dist/
node_modules
/dist
# local env files
.env.local
.env.*.local
# Log files
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Editor directories and files
.idea
.vscode
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?

View File

@ -1,8 +0,0 @@
// https://github.com/michael-ciniawsky/postcss-load-config
module.exports = {
"plugins": {
// to edit target browsers: use "browserlist" field in package.json
"autoprefixer": {}
}
}

42
LICENSE
View File

@ -1,21 +1,21 @@
MIT License
Copyright (c) 2017-2018 Alex Thomassen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
MIT License
Copyright (c) 2017-2020 Alex Thomassen
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

5
babel.config.js Normal file
View File

@ -0,0 +1,5 @@
module.exports = {
presets: [
'@vue/cli-plugin-babel/preset',
],
};

View File

@ -1,35 +0,0 @@
require('./check-versions')()
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')
var spinner = ora('building for production...')
spinner.start()
rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => {
if (err) throw err
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'
))
})
})

View File

@ -1,48 +0,0 @@
var chalk = require('chalk')
var semver = require('semver')
var packageConfig = require('../package.json')
var shell = require('shelljs')
function exec (cmd) {
return require('child_process').execSync(cmd).toString().trim()
}
var versionRequirements = [
{
name: 'node',
currentVersion: semver.clean(process.version),
versionRequirement: packageConfig.engines.node
},
]
if (shell.which('npm')) {
versionRequirements.push({
name: 'npm',
currentVersion: exec('npm --version'),
versionRequirement: packageConfig.engines.npm
})
}
module.exports = function () {
var warnings = []
for (var i = 0; i < versionRequirements.length; i++) {
var mod = versionRequirements[i]
if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) {
warnings.push(mod.name + ': ' +
chalk.red(mod.currentVersion) + ' should be ' +
chalk.green(mod.versionRequirement)
)
}
}
if (warnings.length) {
console.log('')
console.log(chalk.yellow('To use this template, you must update following to modules:'))
console.log()
for (var i = 0; i < warnings.length; i++) {
var warning = warnings[i]
console.log(' ' + warning)
}
console.log()
process.exit(1)
}
}

View File

@ -1,9 +0,0 @@
/* eslint-disable */
require('eventsource-polyfill')
var hotClient = require('webpack-hot-middleware/client?noInfo=true&reload=true')
hotClient.subscribe(function (event) {
if (event.action === 'reload') {
window.location.reload()
}
})

View File

@ -1,89 +0,0 @@
require('./check-versions')()
var config = require('../config')
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 proxyMiddleware = require('http-proxy-middleware')
var webpackConfig = require('./webpack.dev.conf')
// 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
var app = express()
var compiler = webpack(webpackConfig)
var devMiddleware = require('webpack-dev-middleware')(compiler, {
publicPath: webpackConfig.output.publicPath,
quiet: true
})
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) {
hotMiddleware.publish({ action: 'reload' })
cb()
})
})
// proxy api requests
Object.keys(proxyTable).forEach(function (context) {
var options = proxyTable[context]
if (typeof options === 'string') {
options = { target: options }
}
app.use(proxyMiddleware(options.filter || context, options))
})
// handle fallback for HTML5 history API
app.use(require('connect-history-api-fallback')())
// serve webpack bundle output
app.use(devMiddleware)
// enable hot-reload and state-preserving
// compilation error display
app.use(hotMiddleware)
// serve pure static assets
var staticPath = path.posix.join(config.dev.assetsPublicPath, config.dev.assetsSubDirectory)
app.use(staticPath, express.static('./static'))
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)
}
_resolve()
})
var server = app.listen(port)
module.exports = {
ready: readyPromise,
close: () => {
server.close()
}
}

View File

@ -1,70 +0,0 @@
var path = require('path')
var config = require('../config')
var ExtractTextPlugin = require('extract-text-webpack-plugin')
exports.assetsPath = function (_path) {
var assetsSubDirectory = process.env.NODE_ENV === 'production'
? config.build.assetsSubDirectory
: config.dev.assetsSubDirectory
return path.posix.join(assetsSubDirectory, _path)
}
exports.cssLoaders = function (options) {
options = options || {}
var cssLoader = {
loader: 'css-loader',
options: {
sourceMap: options.sourceMap
}
}
// generate loader string to be used with extract text plugin
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({
use: loaders,
fallback: 'vue-style-loader'
})
} else {
return ['vue-style-loader'].concat(loaders)
}
}
// https://vue-loader.vuejs.org/en/configurations/extract-css.html
return {
css: generateLoaders(),
postcss: generateLoaders(),
less: generateLoaders('less'),
sass: generateLoaders('sass', { indentedSyntax: true }),
scss: generateLoaders('sass'),
stylus: generateLoaders('stylus'),
styl: generateLoaders('stylus')
}
}
// Generate loaders for standalone style files (outside of .vue)
exports.styleLoaders = function (options) {
var output = []
var loaders = exports.cssLoaders(options)
for (var extension in loaders) {
var loader = loaders[extension]
output.push({
test: new RegExp('\\.' + extension + '$'),
use: loader
})
}
return output
}

View File

@ -1,12 +0,0 @@
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
})
}

View File

@ -1,67 +0,0 @@
var path = require('path')
var utils = require('./utils')
var config = require('../config')
var vueLoaderConfig = require('./vue-loader.conf')
function resolve (dir) {
return path.join(__dirname, '..', dir)
}
module.exports = {
entry: {
app: './src/main.js'
},
output: {
path: config.build.assetsRoot,
filename: '[name].js',
publicPath: process.env.NODE_ENV === 'production'
? config.build.assetsPublicPath
: config.dev.assetsPublicPath
},
resolve: {
extensions: ['.js', '.vue', '.json'],
alias: {
'vue$': 'vue/dist/vue.esm.js',
'@': resolve('src')
}
},
module: {
rules: [
{
test: /\.(js|vue)$/,
loader: 'eslint-loader',
enforce: 'pre',
include: [resolve('src'), resolve('test')],
options: {
formatter: require('eslint-friendly-formatter')
}
},
{
test: /\.vue$/,
loader: 'vue-loader',
options: vueLoaderConfig
},
{
test: /\.js$/,
loader: 'babel-loader',
include: [resolve('src'), resolve('test')]
},
{
test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
loader: 'url-loader',
options: {
limit: 10000,
name: utils.assetsPath('img/[name].[hash:7].[ext]')
}
},
{
test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
loader: 'url-loader',
options: {
limit: 10000,
name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
}
}
]
}
}

View File

@ -1,39 +0,0 @@
var utils = require('./utils')
var webpack = require('webpack')
var config = require('../config')
var merge = require('webpack-merge')
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) {
baseWebpackConfig.entry[name] = ['./build/dev-client'].concat(baseWebpackConfig.entry[name])
})
module.exports = merge(baseWebpackConfig, {
module: {
rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap })
},
// cheap-module-eval-source-map is faster for development
devtool: '#cheap-module-eval-source-map',
plugins: [
new webpack.DefinePlugin({
'process.env': config.dev.env
}),
// https://github.com/glenjamin/webpack-hot-middleware#installation--usage
new webpack.HotModuleReplacementPlugin(),
new webpack.NoEmitOnErrorsPlugin(),
// https://github.com/ampedandwired/html-webpack-plugin
new HtmlWebpackPlugin({
filename: 'index.html',
template: 'index.html',
inject: true
}),
new FriendlyErrorsPlugin(),
new webpack.ProvidePlugin({
jQuery: 'jquery',
$: 'jquery',
})
]
})

View File

@ -1,124 +0,0 @@
var path = require('path')
var utils = require('./utils')
var webpack = require('webpack')
var config = require('../config')
var merge = require('webpack-merge')
var baseWebpackConfig = require('./webpack.base.conf')
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 = config.build.env
var webpackConfig = merge(baseWebpackConfig, {
module: {
rules: utils.styleLoaders({
sourceMap: config.build.productionSourceMap,
extract: true
})
},
devtool: config.build.productionSourceMap ? '#source-map' : false,
output: {
path: config.build.assetsRoot,
filename: utils.assetsPath('js/[name].[chunkhash].js'),
chunkFilename: utils.assetsPath('js/[id].[chunkhash].js')
},
plugins: [
// http://vuejs.github.io/vue-loader/en/workflow/production.html
new webpack.DefinePlugin({
'process.env': env
}),
new webpack.optimize.UglifyJsPlugin({
compress: {
warnings: false
},
sourceMap: true
}),
// extract css into its own file
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
new HtmlWebpackPlugin({
filename: config.build.index,
template: 'index.html',
inject: true,
minify: {
removeComments: true,
collapseWhitespace: true,
removeAttributeQuotes: true
// more options:
// https://github.com/kangax/html-minifier#options-quick-reference
},
// necessary to consistently work with multiple chunks via CommonsChunkPlugin
chunksSortMode: 'dependency'
}),
// split vendor js into its own file
new webpack.optimize.CommonsChunkPlugin({
name: 'vendor',
minChunks: function (module, count) {
// any required modules inside node_modules are extracted to vendor
return (
module.resource &&
/\.js$/.test(module.resource) &&
module.resource.indexOf(
path.join(__dirname, '../node_modules')
) === 0
)
}
}),
// extract webpack runtime and module manifest to its own file in order to
// prevent vendor hash from being updated whenever app bundle is updated
new webpack.optimize.CommonsChunkPlugin({
name: 'manifest',
chunks: ['vendor']
}),
// copy custom static assets
new CopyWebpackPlugin([
{
from: path.resolve(__dirname, '../static'),
to: config.build.assetsSubDirectory,
ignore: ['.*']
}
]),
new webpack.ProvidePlugin({
jQuery: 'jquery',
$: 'jquery',
})
]
})
if (config.build.productionGzip) {
var CompressionWebpackPlugin = require('compression-webpack-plugin')
webpackConfig.plugins.push(
new CompressionWebpackPlugin({
asset: '[path].gz[query]',
algorithm: 'gzip',
test: new RegExp(
'\\.(' +
config.build.productionGzipExtensions.join('|') +
')$'
),
threshold: 10240,
minRatio: 0.8
})
)
}
if (config.build.bundleAnalyzerReport) {
var BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin
webpackConfig.plugins.push(new BundleAnalyzerPlugin())
}
module.exports = webpackConfig

View File

@ -1,6 +0,0 @@
var merge = require('webpack-merge')
var prodEnv = require('./prod.env')
module.exports = merge(prodEnv, {
NODE_ENV: '"development"'
})

View File

@ -1,38 +0,0 @@
// see http://vuejs-templates.github.io/webpack for documentation.
var path = require('path')
module.exports = {
build: {
env: require('./prod.env'),
index: path.resolve(__dirname, '../dist/index.html'),
assetsRoot: path.resolve(__dirname, '../dist'),
assetsSubDirectory: 'static',
assetsPublicPath: '/',
productionSourceMap: true,
// Gzip off by default as many popular static hosts such as
// Surge or Netlify already gzip all static assets for you.
// Before setting to `true`, make sure to:
// npm install --save-dev compression-webpack-plugin
productionGzip: false,
productionGzipExtensions: ['js', 'css'],
// Run the build command with an extra argument to
// View the bundle analyzer report after build finishes:
// `npm run build --report`
// Set to `true` or `false` to always turn it on or off
bundleAnalyzerReport: process.env.npm_config_report
},
dev: {
env: require('./dev.env'),
port: 8080,
autoOpenBrowser: true,
assetsSubDirectory: 'static',
assetsPublicPath: '/',
proxyTable: {},
// CSS Sourcemaps off by default because relative paths are "buggy"
// with this option, according to the CSS-Loader README
// (https://github.com/webpack/css-loader#sourcemaps)
// In our experience, they generally work as expected,
// just be aware of this issue when enabling this option.
cssSourceMap: false
}
}

View File

@ -1,3 +0,0 @@
module.exports = {
NODE_ENV: '"production"'
}

View File

@ -1,11 +1,11 @@
[[redirects]]
from = "/*"
to = "/index.html"
status = 200
[[headers]]
for = "/*"
[headers.values]
X-Frame-Options = "DENY"
X-XSS-Protection = "1; mode=block"
[[redirects]]
from = "/*"
to = "/index.html"
status = 200
[[headers]]
for = "/*"
[headers.values]
X-Frame-Options = "DENY"
X-XSS-Protection = "1; mode=block"
X-Content-Type-Options = "nosniff"

14234
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,75 +1,34 @@
{
"name": "decapi-docs",
"version": "1.0.0",
"description": "Docs for DecAPI",
"author": "Alex Thomassen <alex@thomassen.xyz>",
"version": "2.0.0",
"private": true,
"scripts": {
"dev": "node build/dev-server.js",
"start": "node build/dev-server.js",
"build": "node build/build.js",
"lint": "eslint --ext .js,.vue src"
"serve": "vue-cli-service serve",
"build": "vue-cli-service build",
"lint": "vue-cli-service lint"
},
"dependencies": {
"bootstrap": "^4.4.1",
"core-js": "^3.6.4",
"jquery": "^3.5.0",
"js-yaml": "^3.13.1",
"popper.js": "^1.16.1",
"vue": "^2.6.11",
"vue-resource": "^1.5.1",
"vue-router": "^2.8.1",
"vuex": "^2.5.0"
"vue-router": "^3.1.6",
"vuex": "^3.1.3"
},
"devDependencies": {
"autoprefixer": "^6.7.2",
"babel-core": "^6.26.3",
"babel-eslint": "^7.1.1",
"babel-loader": "^6.2.10",
"babel-plugin-transform-runtime": "^6.22.0",
"babel-preset-env": "^1.7.0",
"babel-preset-stage-2": "^6.22.0",
"babel-register": "^6.22.0",
"chalk": "^1.1.3",
"connect-history-api-fallback": "^1.6.0",
"copy-webpack-plugin": "^4.6.0",
"css-loader": "^3.5.3",
"eslint": "^3.19.0",
"eslint-config-airbnb-base": "^11.3.2",
"eslint-friendly-formatter": "^2.0.7",
"eslint-import-resolver-webpack": "^0.8.4",
"eslint-loader": "^1.7.1",
"eslint-plugin-html": "^2.0.0",
"@vue/cli-plugin-babel": "~4.3.0",
"@vue/cli-plugin-eslint": "~4.3.0",
"@vue/cli-plugin-router": "~4.3.0",
"@vue/cli-plugin-vuex": "~4.3.0",
"@vue/cli-service": "~4.3.0",
"@vue/eslint-config-airbnb": "^5.0.2",
"babel-eslint": "^10.1.0",
"eslint": "^6.7.2",
"eslint-plugin-import": "^2.20.2",
"eventsource-polyfill": "^0.9.6",
"express": "^4.17.1",
"extract-text-webpack-plugin": "^2.0.0",
"file-loader": "^0.11.1",
"friendly-errors-webpack-plugin": "^1.7.0",
"html-webpack-plugin": "^2.28.0",
"http-proxy-middleware": "^0.18.0",
"opn": "^4.0.2",
"optimize-css-assets-webpack-plugin": "^5.0.3",
"ora": "^1.4.0",
"rimraf": "^2.7.1",
"semver": "^5.7.1",
"shelljs": "^0.7.6",
"url-loader": "^1.1.2",
"vue-loader": "^12.1.0",
"vue-style-loader": "^3.1.2",
"vue-template-compiler": "^2.6.11",
"webpack": "^2.6.1",
"webpack-bundle-analyzer": "^3.7.0",
"webpack-dev-middleware": "^1.12.2",
"webpack-hot-middleware": "^2.25.0",
"webpack-merge": "^4.2.2"
},
"engines": {
"node": ">= 4.0.0",
"npm": ">= 3.0.0"
},
"browserslist": [
"> 1%",
"last 2 versions",
"not ie <= 8"
]
"eslint-plugin-vue": "^6.2.2",
"vue-template-compiler": "^2.6.11"
}
}

View File

@ -1,12 +1,15 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>DecAPI Docs</title>
<link href="https://stackpath.bootstrapcdn.com/bootswatch/4.3.1/cosmo/bootstrap.min.css" rel="stylesheet" integrity="sha384-uhut8PejFZO8994oEgm/ZfAv0mW1/b83nczZzSwElbeILxwkN491YQXsCFTE6+nx" crossorigin="anonymous">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.11.2/css/all.css" integrity="sha384-KA6wR/X5RY4zFAHpv/CnoG2UW1uogYfdnP67Uv7eULvTveboZJg0qUpmJZb5VqzN" crossorigin="anonymous">
<link href="https://stackpath.bootstrapcdn.com/bootswatch/4.4.1/cosmo/bootstrap.min.css" rel="stylesheet"
integrity="sha384-qdQEsAI45WFCO5QwXBelBe1rR9Nwiss4rGEqiszC+9olH1ScrLrMQr1KmDR964uZ" crossorigin="anonymous">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.13.0/css/all.css"
integrity="sha384-Bfad6CLCknfcloXFOyFnlgtENryhrpZCe29RTifKEixXQZ38WheV+i/6YWSzkz3V" crossorigin="anonymous">
<link rel="stylesheet" href="/static/css/custom.css">
<style media="screen">
body {
@ -22,26 +25,16 @@
font-weight: bold;
}
.botSelection:hover, .endpointListItem:hover {
.botSelection:hover,
.endpointListItem:hover {
cursor: pointer;
}
</style>
</head>
<body>
<div id="app"></div>
<script>
(function (i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date(); a = s.createElement(o),
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
})(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-56279022-1', 'auto');
ga('send', 'pageview');
</script>
<!-- Matomo -->
<script type="text/javascript">
var _paq = _paq || [];
@ -58,4 +51,5 @@
</script>
<!-- End Matomo Code -->
</body>
</html>

View File

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View File

Before

Width:  |  Height:  |  Size: 72 KiB

After

Width:  |  Height:  |  Size: 72 KiB

View File

@ -2,7 +2,10 @@
<div id="app">
<nav class="navbar fixed-top navbar-dark navbar-expand-lg bg-dark" role="navigation">
<a class="navbar-brand" href="/">DecAPI Docs</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#topNavDropdown" aria-controls="topNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
<button
class="navbar-toggler" type="button"
data-toggle="collapse" data-target="#topNavDropdown"
aria-controls="topNavDropdown" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
@ -18,7 +21,9 @@
<ul class="nav navbar-nav justify-content-end">
<li class="navbar-item">
<a v-bind:href="config.discordUrl" class="nav-link"><i class="fab fa-discord fa-fw"></i> Discord server</a>
<a v-bind:href="config.discordUrl" class="nav-link">
<i class="fab fa-discord fa-fw"></i> Discord server
</a>
</li>
<li class="navbar-item">
<a href="https://github.com/Decicus/DecAPI-Docs" class="nav-link"><i class="fas fa-book fa-fw"></i> DecAPI Docs on GitHub</a>
@ -37,17 +42,17 @@
</template>
<script>
import config from './config';
import config from './config';
export default {
name: 'app',
created() {
this.$store.dispatch('LOAD_BASE_ENDPOINTS');
},
data() {
return {
config,
};
},
};
export default {
name: 'app',
created() {
this.$store.dispatch('LOAD_BASE_ENDPOINTS');
},
data() {
return {
config,
};
},
};
</script>

View File

@ -14,13 +14,13 @@
</template>
<script>
import config from '../config';
import config from '../config';
export default {
data() {
return {
config,
};
},
};
export default {
data() {
return {
config,
};
},
};
</script>

View File

@ -1,10 +0,0 @@
<template></template>
<script>
export default {
name: 'Endpoint',
data() {
return {};
},
};
</script>

View File

@ -192,160 +192,161 @@
</style>
<script>
import yaml from 'js-yaml';
import jQuery from 'jquery';
import 'bootstrap';
import config from '../config';
import yaml from 'js-yaml';
import jQuery from 'jquery';
import 'bootstrap';
import config from '../config';
const $ = jQuery;
const $ = jQuery;
/**
/**
* Set default setting in "Bot example settings" dropdown.
*/
const bots = {
ankhbot: true,
slcloudbot: true,
deepbot: false,
fossabot: true,
nightbot: true,
ohbot: false,
phantombot: false,
streamelements: true,
};
const bots = {
ankhbot: true,
slcloudbot: true,
deepbot: false,
fossabot: true,
nightbot: true,
ohbot: false,
phantombot: false,
streamelements: true,
};
export default {
name: 'EndpointList',
data() {
return {
basePath: '',
bots,
/**
export default {
name: 'EndpointList',
data() {
return {
basePath: '',
bots,
/**
* Display names in "Bot example settings" dropdown.
*/
botNames: {
ankhbot: 'Streamlabs Chatbot',
slcloudbot: 'Streamlabs Cloudbot',
deepbot: 'Deepbot',
fossabot: 'Fossabot',
nightbot: 'Nightbot',
ohbot: 'Ohbot',
phantombot: 'PhantomBot',
streamelements: 'StreamElements',
},
config,
// Endpoint data
e: {
bots: true,
deprecated: false,
method: 'GET',
notes: [],
parameters: [],
qs: [],
url: '',
},
endpoints: [],
route: this.$route.path,
};
},
methods: {
openModal(route) {
this.route = `${this.$route.path}/${route}`;
this.e.url = config.baseUrl + this.route;
this.endpoints.forEach((end) => {
if (route !== end.route) {
return;
}
Object.keys(end).forEach((name) => {
if (this.e[name] !== undefined) {
this.e[name] = end[name];
}
/**
* If an endpoint isn't targeted towards bots, it's explicitly marked as such.
* Default should be to assume it's targeted towards bots.
*/
if (end.bots === undefined) {
end.bots = true;
}
this.e.deprecated = !!end.deprecated;
if (!end.qs || end.qs.length === 0) {
this.e.qs = [];
}
if (!end.parameters || end.parameters.length === 0) {
this.e.parameters = [];
}
});
this.$router.push({
query: {
endpoint: route || '/',
},
});
$('#endpoint').modal('toggle');
});
botNames: {
ankhbot: 'Streamlabs Chatbot',
slcloudbot: 'Streamlabs Cloudbot',
deepbot: 'Deepbot',
fossabot: 'Fossabot',
nightbot: 'Nightbot',
ohbot: 'Ohbot',
phantombot: 'PhantomBot',
streamelements: 'StreamElements',
},
updateBotStore() {
localStorage.setItem('bots', JSON.stringify(bots));
config,
// Endpoint data
e: {
bots: true,
deprecated: false,
method: 'GET',
notes: [],
parameters: [],
qs: [],
url: '',
},
},
endpoints: [],
route: this.$route.path,
};
},
mounted() {
const path = this.$route.path.replace('/', '');
const endpoint = this.$route.query.endpoint || '';
methods: {
openModal(route) {
this.route = `${this.$route.path}/${route}`;
this.$http.get(`/static/yaml/endpoints/${path}.yaml`).then((response) => {
const { body } = response;
const data = yaml.load(body);
this.e.url = config.baseUrl + this.route;
const basePath = data.base_path;
const endpoints = data.endpoints;
this.endpoints.forEach((end) => {
if (route !== end.route) {
return;
}
this.basePath = basePath;
this.endpoints = endpoints;
endpoints.forEach((end) => {
const route = decodeURIComponent(endpoint);
if (route === '') {
return;
Object.keys(end).forEach((name) => {
if (this.e[name] !== undefined) {
this.e[name] = end[name];
}
if ((end.route === '' && route !== '/') || end.route !== route) {
return;
/**
* If an endpoint isn't targeted towards bots, it's explicitly marked as such.
* Default should be to assume it's targeted towards bots.
*/
if (end.bots === undefined) {
// eslint-disable-next-line no-param-reassign
end.bots = true;
}
this.openModal(end.route);
this.e.deprecated = !!end.deprecated;
if (!end.qs || end.qs.length === 0) {
this.e.qs = [];
}
if (!end.parameters || end.parameters.length === 0) {
this.e.parameters = [];
}
});
});
let getBots = localStorage.getItem('bots');
if (getBots) {
getBots = JSON.parse(getBots);
Object.keys(getBots).forEach((name) => {
bots[name] = getBots[name];
});
}
$('#endpoint').on('hidden.bs.modal', () => {
this.$router.push({
query: {},
query: {
endpoint: route || '/',
},
});
});
$('.dropdown-menu').on({
click: (e) => {
e.stopPropagation();
},
$('#endpoint').modal('toggle');
});
},
};
updateBotStore() {
localStorage.setItem('bots', JSON.stringify(bots));
},
},
mounted() {
const path = this.$route.path.replace('/', '');
const endpoint = this.$route.query.endpoint || '';
this.$http.get(`/static/yaml/endpoints/${path}.yaml`).then((response) => {
const { body } = response;
const data = yaml.load(body);
const basePath = data.base_path;
const { endpoints } = data;
this.basePath = basePath;
this.endpoints = endpoints;
endpoints.forEach((end) => {
const route = decodeURIComponent(endpoint);
if (route === '') {
return;
}
if ((end.route === '' && route !== '/') || end.route !== route) {
return;
}
this.openModal(end.route);
});
});
let getBots = localStorage.getItem('bots');
if (getBots) {
getBots = JSON.parse(getBots);
Object.keys(getBots).forEach((name) => {
bots[name] = getBots[name];
});
}
$('#endpoint').on('hidden.bs.modal', () => {
this.$router.push({
query: {},
});
});
$('.dropdown-menu').on({
click: (e) => {
e.stopPropagation();
},
});
},
};
</script>

View File

@ -1,53 +0,0 @@
<template>
<div class="hello">
<h1>{{ msg }}</h1>
<h2>Essential Links</h2>
<ul>
<li><a href="https://vuejs.org" target="_blank">Core Docs</a></li>
<li><a href="https://forum.vuejs.org" target="_blank">Forum</a></li>
<li><a href="https://gitter.im/vuejs/vue" target="_blank">Gitter Chat</a></li>
<li><a href="https://twitter.com/vuejs" target="_blank">Twitter</a></li>
<br>
<li><a href="http://vuejs-templates.github.io/webpack/" target="_blank">Docs for This Template</a></li>
</ul>
<h2>Ecosystem</h2>
<ul>
<li><a href="http://router.vuejs.org/" target="_blank">vue-router</a></li>
<li><a href="http://vuex.vuejs.org/" target="_blank">vuex</a></li>
<li><a href="http://vue-loader.vuejs.org/" target="_blank">vue-loader</a></li>
<li><a href="https://github.com/vuejs/awesome-vue" target="_blank">awesome-vue</a></li>
</ul>
</div>
</template>
<script>
export default {
name: 'hello',
data() {
return {
msg: 'Welcome to Your Vue.js App',
};
},
};
</script>
<!-- Add "scoped" attribute to limit CSS to this component only -->
<style scoped>
h1, h2 {
font-weight: normal;
}
ul {
list-style-type: none;
padding: 0;
}
li {
display: inline-block;
margin: 0 10px;
}
a {
color: #42b983;
}
</style>

View File

@ -43,7 +43,9 @@
<li class="list-group-item">For endpoints that mention JSON support without any further information, send <code>Accept: application/json</code> in the request header to receive the response as JSON instead.</li>
<li class="list-group-item">Parameters are <strong>always</strong> required.</li>
<li class="list-group-item">Query strings are <strong>never</strong> required.</li>
<li class="list-group-item">Parameter/query string examples may be prefixed by a colon (<code>:</code>), for example: <code>:username</code> or <code>:channel</code>. These should be omitted and replaced by the input value from the actual requests.</li>
<li class="list-group-item">Parameter/query string examples may be prefixed by a colon (<code>:</code>),
for example: <code>:username</code> or <code>:channel</code>. These should be omitted and replaced by the input value from the actual requests.
</li>
</div>
</div>
</div>
@ -157,7 +159,9 @@
<br>
In that case you're probably really confused as to how to use this, so this is an attempt to explain a few things for some of you.
<br>
If you have any further questions after reading this, then feel free to <a v-bind:href="config.discordUrl">visit our <i class="fab fa-discord"></i> Discord server</a> or contact me via the information on my <a href="/contact">contact page</a>, and I will attempt to reply to the best of my ability.
If you have any further questions after reading this, feel free to <a v-bind:href="config.discordUrl">visit our <i class="fab fa-discord"></i> Discord server</a>.
<br>
Alternatively contact me via the information on my <a href="/contact">contact page</a>, and I will attempt to reply to the best of my ability.
<br>
<br>
@ -267,22 +271,22 @@
</template>
<script>
import config from '../config';
import config from '../config';
export default {
data() {
return {
baseEndpoints: [],
baseUrl: config.baseUrl,
config,
};
},
export default {
data() {
return {
baseEndpoints: [],
baseUrl: config.baseUrl,
config,
};
},
created() {
this.baseEndpoints = this.$store.state.baseEndpoints;
this.$store.watch((state) => {
this.baseEndpoints = state.baseEndpoints;
});
},
};
created() {
this.baseEndpoints = this.$store.state.baseEndpoints;
this.$store.watch((state) => {
this.baseEndpoints = state.baseEndpoints;
});
},
};
</script>

View File

@ -1,5 +1,4 @@
export default {
baseUrl: 'https://decapi.me',
beastnodeUrl: 'https://links.decapi.me/beastnode',
discordUrl: 'https://links.decapi.me/discord',
};

View File

@ -1,17 +1,12 @@
// The Vue build version to load with the `import` command
// (runtime-only or standalone) has been set in webpack.base.conf with an alias.
import Vue from 'vue';
import App from './App';
import App from './App.vue';
import router from './router';
import store from './store';
Vue.config.productionTip = false;
/* eslint-disable no-new */
new Vue({
el: '#app',
router,
store,
template: '<App/>',
components: { App },
});
render: (h) => h(App),
}).$mount('#app');

View File

@ -1,10 +1,10 @@
import Vue from 'vue';
import VueResource from 'vue-resource';
import Router from 'vue-router';
import EndpointList from '@/components/EndpointList';
import Home from '@/components/Home';
import Contact from '@/components/Contact';
import yaml from 'js-yaml';
import EndpointList from '../components/EndpointList.vue';
import Home from '../components/Home.vue';
import Contact from '../components/Contact.vue';
Vue.use(Router);
Vue.use(VueResource);

View File

@ -12,12 +12,14 @@ const store = new Vuex.Store({
},
actions: {
LOAD_BASE_ENDPOINTS({ commit }) {
Vue.http.get('/static/yaml/base/base_endpoints.yaml').then(({ body }) => {
const baseEndpoints = yaml.load(body);
commit('UPDATE_BASE_ENDPOINTS', {
baseEndpoints,
Vue.http
.get('/static/yaml/base/base_endpoints.yaml')
.then(({ body }) => {
const baseEndpoints = yaml.load(body);
commit('UPDATE_BASE_ENDPOINTS', {
baseEndpoints,
});
});
});
},
},
mutations: {

5
src/views/About.vue Normal file
View File

@ -0,0 +1,5 @@
<template>
<div class="about">
<h1>This is an about page</h1>
</div>
</template>

18
src/views/Home.vue Normal file
View File

@ -0,0 +1,18 @@
<template>
<div class="home">
<img alt="Vue logo" src="../assets/logo.png">
<HelloWorld msg="Welcome to Your Vue.js App"/>
</div>
</template>
<script>
// @ is an alias to /src
import HelloWorld from '@/components/HelloWorld.vue';
export default {
name: 'Home',
components: {
HelloWorld,
},
};
</script>