Skip to content

Commit c128357

Browse files
Shigure92Shigure92
committed
release: 1.0.0
0 parents  commit c128357

14 files changed

+554
-0
lines changed

‎.babelrc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"presets": [
3+
[
4+
"@babel/preset-env",
5+
{
6+
"useBuiltIns": "usage",
7+
"corejs": "3.0.0"
8+
}
9+
]
10+
],
11+
"plugins": [
12+
"@babel/plugin-syntax-dynamic-import",
13+
"@babel/plugin-proposal-class-properties"
14+
]
15+
}

‎.browserslistrc

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
>= 0.5%
2+
last 2 major versions
3+
not dead
4+
Chrome >= 60
5+
Firefox >= 60
6+
Firefox ESR
7+
iOS >= 12
8+
Safari >= 12
9+
not Explorer <= 11

‎.eslintrc

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

‎.gitignore

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# dependencies
2+
node_modules
3+
4+
# production
5+
dist/*
6+
!dist/index.html
7+
8+
# misc
9+
.DS_Store
10+
11+
npm-debug.log
12+
yarn-error.log
13+
yarn.lock
14+
.yarnclean
15+
.vscode
16+
package-lock.json

‎.prettierignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
dist/
2+
mdb/

‎.prettierrc

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"bracketSpacing": true,
3+
"semi": true,
4+
"singleQuote": true,
5+
"trailingComma": "es5",
6+
"printWidth": 100,
7+
"endOfLine": "auto"
8+
}

‎README.md

+85
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
![MDB Logo](https://mdbootstrap.com/img/Marketing/general/logo/medium/mdb-r.png)
2+
3+
# MDB 5 Webpack Starter
4+
5+
### Webpack boilerplate for Bootstrap 5 & Material Design 2.0 UI Kit
6+
7+
**[>> Support MDB 5 with a STAR](https://github.com/mdbootstrap/mdb-ui-kit/)**
8+
9+
**[>> MDB 5 Demo](https://mdbootstrap.com/docs/standard/#demo)**
10+
11+
<a href="https://npmcharts.com/compare/mdbootstrap?minimal=true"> <img src="https://img.shields.io/npm/dm/mdbootstrap.svg?label=MDB%20Downloads" alt="Downloads"></a>
12+
<a href="https://github.com/mdbootstrap/bootstrap-material-design/blob/master/License.pdf"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License"></a>
13+
<a href="https://twitter.com/intent/tweet/?text=Thanks+@mdbootstrap+for+creating+amazing+and+free+Material+Design+for+Bootstrap+4+UI+KIT%20https://mdbootstrap.com/docs/jquery/&hashtags=javascript,code,webdesign,bootstrap"><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Let%20us%20know%20you%20were%20here%21&"></a>
14+
<a href="https://www.youtube.com/watch?v=c9B4TPnak1A&t=6s"><img alt="YouTube Video Views" src="https://img.shields.io/youtube/views/c9B4TPnak1A?label=Bootstrap%205%20Tutorial%20Views&style=social"></a>
15+
16+
___
17+
18+
> :warning: The use of this Starter is at your own risk and assumes basic knowledge of Webpack, JavaScript and CSS preprocessors. We recommend creating custom versions of MDB UI KIT and themes only for advanced developers.
19+
20+
___
21+
22+
### Installation
23+
```
24+
npm install
25+
```
26+
27+
> **Pro Essential installation**
28+
> ```
29+
> npm install git+https://oauth2:[email protected]/mdb/standard/mdb-ui-kit-pro-essential
30+
> ```
31+
32+
> **Pro Advanced installation**
33+
> ```
34+
> npm install git+https://oauth2:[email protected]/mdb/standard/mdb-ui-kit-pro-advanced
35+
> ```
36+
37+
### Dev Server
38+
```
39+
npm run start
40+
```
41+
42+
### Build
43+
```
44+
npm run build
45+
```
46+
47+
### Features:
48+
49+
* Bundling via [Webpack](https://github.com/webpack/webpack) 5.74.0
50+
* ES6+ Support via [babel-cli](https://github.com/babel/babel) v7.18.10
51+
* SASS Support via [sass-loader](https://github.com/webpack-contrib/sass-loader) v13.0.2
52+
* Linting via [eslint-webpack-plugin](https://github.com/webpack-contrib/eslint-webpack-plugin) v3.2.0
53+
* Unit Testing via [jest](https://github.com/facebook/jest) v29.0.1
54+
* Code Formatting via [prettier](https://github.com/prettier/prettier) v2.7.1
55+
56+
### Files structure:
57+
58+
```
59+
my-project/
60+
├── dist/
61+
│ └── index.html
62+
├── src/
63+
│ ├── js/
64+
│ └── scss/
65+
└── webpack.config.js
66+
```
67+
<br><br>
68+
69+
___
70+
71+
# MDB UI KIT - Importing of MDB files
72+
73+
### Importing JS modules
74+
You can import the entire library or just individual modules:
75+
```
76+
import * as mdb from 'mdb-ui-kit'; // lib
77+
import { Input } from 'mdb-ui-kit'; // module
78+
import { Input as CustomInput } from 'mdb-ui-kit'; // module with custom name
79+
```
80+
81+
### Importing CSS file
82+
To import MDB stylesheet please use the following syntax:
83+
```
84+
@import '~mdb-ui-kit/css/mdb.min.css';
85+
```

0 commit comments

Comments
 (0)