Skip to content

Commit 145bd71

Browse files
kiwicopplekiwicopple
committed
Adds the docs folder
1 parent f162e4e commit 145bd71

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+26194
-0
lines changed

‎README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Run any of the bin files in the `bin` directory
1515
./bin/start-windows.exe
1616
```
1717

18+
Then you can call any of the following
19+
20+
1821
## FAQs
1922

2023
**What security does this use?**

‎docs/.dockerignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
npm-debug.log

‎docs/.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
end_of_line = lf
5+
indent_style = space
6+
indent_size = 4
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

‎docs/.eslintrc.json

Lines changed: 265 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,265 @@
1+
{
2+
"env": {
3+
"es6": true,
4+
"node": true
5+
},
6+
"extends": "eslint:recommended",
7+
"rules": {
8+
"accessor-pairs": "error",
9+
"array-bracket-spacing": [
10+
"off",
11+
"never"
12+
],
13+
"array-callback-return": "error",
14+
"arrow-body-style": "off",
15+
"arrow-parens": [
16+
"off",
17+
"as-needed"
18+
],
19+
"arrow-spacing": [
20+
"error",
21+
{
22+
"after": true,
23+
"before": true
24+
}
25+
],
26+
"block-scoped-var": "off",
27+
"block-spacing": "off",
28+
"brace-style": [
29+
"off",
30+
"stroustrup"
31+
],
32+
"callback-return": "off",
33+
"camelcase": "off",
34+
"class-methods-use-this": "error",
35+
"comma-dangle": "error",
36+
"comma-spacing": "off",
37+
"comma-style": [
38+
"error",
39+
"last"
40+
],
41+
"complexity": "off",
42+
"computed-property-spacing": [
43+
"error",
44+
"never"
45+
],
46+
"consistent-return": "off",
47+
"consistent-this": "error",
48+
"curly": "off",
49+
"default-case": "error",
50+
"dot-location": [
51+
"off",
52+
"property"
53+
],
54+
"dot-notation": [
55+
"error",
56+
{
57+
"allowKeywords": true
58+
}
59+
],
60+
"eol-last": "error",
61+
"eqeqeq": "off",
62+
"func-call-spacing": "error",
63+
"func-name-matching": "off",
64+
"func-names": "off",
65+
"func-style": [
66+
"error",
67+
"declaration"
68+
],
69+
"generator-star-spacing": "off",
70+
"global-require": "off",
71+
"guard-for-in": "off",
72+
"handle-callback-err": "off",
73+
"id-blacklist": "error",
74+
"id-length": "off",
75+
"id-match": "error",
76+
"indent": "off",
77+
"init-declarations": "off",
78+
"jsx-quotes": "error",
79+
"key-spacing": "off",
80+
"keyword-spacing": "off",
81+
"line-comment-position": "off",
82+
"linebreak-style": [
83+
"error",
84+
"unix"
85+
],
86+
"lines-around-comment": "off",
87+
"lines-around-directive": "off",
88+
"max-depth": "off",
89+
"max-len": "off",
90+
"max-lines": "off",
91+
"max-nested-callbacks": "error",
92+
"max-params": "off",
93+
"max-statements": "off",
94+
"max-statements-per-line": "off",
95+
"multiline-ternary": [
96+
"off",
97+
"never"
98+
],
99+
"new-parens": "error",
100+
"newline-after-var": "off",
101+
"newline-before-return": "off",
102+
"newline-per-chained-call": "off",
103+
"no-alert": "error",
104+
"no-array-constructor": "error",
105+
"no-bitwise": "off",
106+
"no-caller": "error",
107+
"no-catch-shadow": "off",
108+
"no-confusing-arrow": "error",
109+
"no-console": "off",
110+
"no-continue": "off",
111+
"no-div-regex": "error",
112+
"no-duplicate-imports": "error",
113+
"no-else-return": "off",
114+
"no-empty": [
115+
"warn",
116+
{
117+
"allowEmptyCatch": true
118+
}
119+
],
120+
"no-empty-function": "off",
121+
"no-eq-null": "error",
122+
"no-eval": "error",
123+
"no-extend-native": "off",
124+
"no-extra-bind": "error",
125+
"no-extra-label": "error",
126+
"no-extra-parens": "off",
127+
"no-floating-decimal": "error",
128+
"no-global-assign": "error",
129+
"no-implicit-globals": "error",
130+
"no-implied-eval": "error",
131+
"no-inline-comments": "off",
132+
"no-inner-declarations": [
133+
"error",
134+
"functions"
135+
],
136+
"no-invalid-this": "off",
137+
"no-iterator": "error",
138+
"no-label-var": "error",
139+
"no-labels": "error",
140+
"no-lone-blocks": "error",
141+
"no-lonely-if": "off",
142+
"no-loop-func": "off",
143+
"no-magic-numbers": "off",
144+
"no-mixed-operators": "error",
145+
"no-mixed-requires": "error",
146+
"no-multi-spaces": "off",
147+
"no-multi-str": "error",
148+
"no-multiple-empty-lines": "error",
149+
"no-negated-condition": "error",
150+
"no-nested-ternary": "off",
151+
"no-new": "error",
152+
"no-new-func": "error",
153+
"no-new-object": "error",
154+
"no-new-require": "error",
155+
"no-new-wrappers": "error",
156+
"no-octal-escape": "error",
157+
"no-param-reassign": "off",
158+
"no-path-concat": "error",
159+
"no-plusplus": "off",
160+
"no-process-env": "off",
161+
"no-process-exit": "off",
162+
"no-proto": "error",
163+
"no-prototype-builtins": "error",
164+
"no-restricted-globals": "error",
165+
"no-restricted-imports": "error",
166+
"no-restricted-modules": "error",
167+
"no-restricted-properties": "error",
168+
"no-restricted-syntax": "error",
169+
"no-return-assign": "off",
170+
"no-script-url": "error",
171+
"no-self-compare": "error",
172+
"no-sequences": "error",
173+
"no-shadow": "off",
174+
"no-shadow-restricted-names": "error",
175+
"no-spaced-func": "error",
176+
"no-sync": "off",
177+
"no-tabs": "off",
178+
"no-template-curly-in-string": "error",
179+
"no-ternary": "off",
180+
"no-throw-literal": "error",
181+
"no-trailing-spaces": "error",
182+
"no-undef-init": "error",
183+
"no-undefined": "warn",
184+
"no-underscore-dangle": "off",
185+
"no-unmodified-loop-condition": "error",
186+
"no-unneeded-ternary": [
187+
"error",
188+
{
189+
"defaultAssignment": true
190+
}
191+
],
192+
"no-unsafe-negation": "error",
193+
"no-unused-expressions": "error",
194+
"no-unused-vars": "off",
195+
"no-use-before-define": "off",
196+
"no-useless-call": "error",
197+
"no-useless-computed-key": "error",
198+
"no-useless-concat": "off",
199+
"no-useless-constructor": "error",
200+
"no-useless-escape": "off",
201+
"no-useless-rename": "error",
202+
"no-var": "off",
203+
"no-void": "error",
204+
"no-warning-comments": "off",
205+
"no-whitespace-before-property": "error",
206+
"no-with": "error",
207+
"object-curly-newline": "off",
208+
"object-curly-spacing": "off",
209+
"object-property-newline": [
210+
"off",
211+
{
212+
"allowMultiplePropertiesPerLine": true
213+
}
214+
],
215+
"object-shorthand": "off",
216+
"one-var": "off",
217+
"one-var-declaration-per-line": "error",
218+
"operator-assignment": "off",
219+
"operator-linebreak": "off",
220+
"padded-blocks": "off",
221+
"prefer-arrow-callback": "off",
222+
"prefer-const": "off",
223+
"prefer-numeric-literals": "error",
224+
"prefer-reflect": "off",
225+
"prefer-rest-params": "error",
226+
"prefer-spread": "error",
227+
"prefer-template": "off",
228+
"quote-props": "off",
229+
"quotes": "off",
230+
"radix": "error",
231+
"require-jsdoc": "off",
232+
"require-yield": "off",
233+
"rest-spread-spacing": "error",
234+
"semi": "off",
235+
"semi-spacing": "off",
236+
"sort-imports": "error",
237+
"sort-keys": "off",
238+
"sort-vars": "off",
239+
"space-before-blocks": "off",
240+
"space-before-function-paren": "off",
241+
"space-in-parens": [
242+
"error",
243+
"never"
244+
],
245+
"space-infix-ops": "off",
246+
"space-unary-ops": "error",
247+
"spaced-comment": "off",
248+
"strict": "error",
249+
"symbol-description": "error",
250+
"template-curly-spacing": "error",
251+
"unicode-bom": [
252+
"error",
253+
"never"
254+
],
255+
"valid-jsdoc": "off",
256+
"vars-on-top": "off",
257+
"wrap-iife": "error",
258+
"wrap-regex": "off",
259+
"yield-star-spacing": "error",
260+
"yoda": [
261+
"error",
262+
"never"
263+
]
264+
}
265+
}

‎docs/.gitignore

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
*.txt
2+
compare.js
3+
doit.sh
4+
source/layouts/layout*.erb
5+
source/images/custom_logo.*
6+
spectacle
7+
dev/
8+
test/
9+
testroot/
10+
11+
# Logs
12+
logs
13+
*.log
14+
npm-debug.log*
15+
16+
# Runtime data
17+
pids
18+
*.pid
19+
*.seed
20+
21+
# Directory for instrumented libs generated by jscoverage/JSCover
22+
lib-cov
23+
24+
# Coverage directory used by tools like istanbul
25+
coverage
26+
27+
# nyc test coverage
28+
.nyc_output
29+
30+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
31+
.grunt
32+
33+
# node-waf configuration
34+
.lock-wscript
35+
36+
# Compiled binary addons (http://nodejs.org/api/addons.html)
37+
build/Release
38+
39+
# Dependency directories
40+
node_modules
41+
jspm_packages
42+
43+
# Optional npm cache directory
44+
.npm
45+
46+
# Optional REPL history
47+
.node_repl_history
48+
.idea

‎docs/.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#

‎docs/.travis.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
language: node_js
2+
node_js:
3+
- "node"
4+
- "lts/*"
5+
- "10"
6+
script:
7+
- npm run build
8+
- npm run lint
9+
- npm run lintejs

‎docs/Dockerfile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
FROM node:dubnium-alpine
2+
3+
WORKDIR /srv/shins
4+
5+
# install dependencies
6+
COPY package.json .
7+
RUN npm install
8+
9+
# install the app
10+
COPY . .
11+
12+
VOLUME /srv/shins/source
13+
14+
EXPOSE 4567
15+
CMD [ "npm", "run", "serve" ]

0 commit comments

Comments
 (0)