forked from BiosBoy/coconat
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
upgrated Reacme file. Added more documentation for code in app.
- Loading branch information
Showing
9 changed files
with
3,715 additions
and
329 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,11 @@ | ||
## Suspense/Lazy/Redux App | ||
|
||
|
||
# 0.0.1 | ||
* App has created. | ||
## Webpack4 - React16.7 Templater App | ||
|
||
|
||
# 0.2.0 | ||
* Added more beatiful mocks (extended from create-react-app). | ||
|
||
# 0.1.0 | ||
* App has been more clearly documented across whole app code. | ||
|
||
# 0.0.1 | ||
* App has been created. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
## Webpack4 - React16.7 Templater App | ||
# Make custom React app development easly as never before! | ||
|
||
# Features: | ||
* Fast React app creation. | ||
* Can be custumized as you whish. | ||
* All needed packages to work you can bootstap just by one command with `lerna` npm package: `lerna bootstrap` | ||
* Support TypeScript version 3^. | ||
|
||
# Webpack: | ||
* Fully support all Webpack 4^ possibilities. | ||
* Support code-splitting and bundles app creation out of the box. | ||
* Created 3 independent development cases: `test`, `development`, `production`. Each of them has own best optimized configuration. | ||
* Integrated Babel 7^ with supporting all ES6-ES8 features. | ||
* Integrated Ujlifty Webpack Plugin ^0 for optimizing JS/JSX/TS/TSX bundles for development and production. | ||
* Integrated Mini CSS Webpack Plugin ^0 + OptimizeCSS Assets Webpack Plugin ^5 for optimizing CSS bundles for development and production. | ||
* Integrated Webpack Bundle Analyzer ^3 for visual analyzing of code/bundles weight. | ||
* Transpile all app code into native ES5 for supporting even an oldest browsers. | ||
|
||
# React: | ||
* Support all new features from React 16.7@-alpha release. | ||
* Hooks, Suspence and Lazy load can be used out of the box. | ||
|
||
# Styling: | ||
* Support CSS/SASS style markup. | ||
* Integrated CSSModules for independent component styling. | ||
* Including PostCSS ^2 post-processor. | ||
|
||
# Testing: | ||
* Integrated Jest 23^ + Enzyme 3^ testing environment. | ||
* Includes pre-commits hooks for testing app before commit (if test are present in). | ||
* Support JS/JSX/TS/TSX file extensions. | ||
|
||
# Linting: | ||
* Integrated `prettier` package for beatify pre-commited code. | ||
* Integrated eslint 5^ + tslint 5^ + stylelint 9^ linters based on the most popular schemas in the world (facebook, microsoft, airbnb, etc.) with React life-cycle ecosystem supporting. | ||
|
||
# Git: | ||
* Includes pre-commits hooks with husky ^1 | ||
* Includes lint-stages ^1 for styling and testing whole app code (js/jsx/ts/tsx/css/scss/json) before commiting. | ||
* Checks code on lint rule errors before accept user commit. | ||
* Run test suits before accept user commit. | ||
|
||
|
||
## Technical information: | ||
# App technical environment that are 100% support with: | ||
* Node 10.5 | ||
* Yarn 1.9.4 | ||
* Webpack 4.23.1 | ||
* React 16.7 | ||
|
||
# App global package installing requirements: | ||
* node | ||
* yarn/npm | ||
* eslint/tsline/stylelint | ||
* lerna | ||
* typescript | ||
|
||
|
||
## FAQ: | ||
# "Command `lerna bootstrap` is does not works." | ||
* To bring it work you need install it globally first by command `yarn add lerna -g`. After that navigate to your working folder and repeat command `lerna bootstrap` one more time. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,22 @@ | ||
module.exports = { | ||
cacheDirectory: '<rootDir>/.tmp/jest', | ||
coverageDirectory: './.tmp/coverage', | ||
moduleNameMapper: { | ||
'^.+\\.(scss)$': 'identity-obj-proxy' | ||
}, | ||
modulePaths: ['<rootDir>'], | ||
moduleFileExtensions: ['js', 'jsx', 'json'], | ||
globals: { | ||
NODE_ENV: 'test' | ||
}, | ||
verbose: true, | ||
testRegex: '(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$', | ||
testPathIgnorePatterns: ['/node_modules/', '/__tests__/mocks/.*'], | ||
transformIgnorePatterns: ['.*(node_modules)(?!.*torn.*).*$'], | ||
transform: { | ||
'^.+\\.js$': 'babel-jest' | ||
}, | ||
setupFiles: ['<rootDir>/setupTests.js'], | ||
snapshotSerializers: ['enzyme-to-json/serializer'] | ||
} | ||
// Jest tesitng config. Responce for app tests. | ||
module.exports = { | ||
cacheDirectory: '<rootDir>/.tmp/jest', | ||
coverageDirectory: './.tmp/coverage', | ||
moduleNameMapper: { | ||
'^.+\\.(scss)$': 'identity-obj-proxy' | ||
}, | ||
modulePaths: ['<rootDir>'], | ||
moduleFileExtensions: ['js', 'jsx', 'json'], | ||
globals: { | ||
NODE_ENV: 'test' | ||
}, | ||
verbose: true, | ||
testRegex: '(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$', | ||
testPathIgnorePatterns: ['/node_modules/', '/__tests__/mocks/.*'], | ||
transformIgnorePatterns: ['.*(node_modules)(?!.*torn.*).*$'], | ||
transform: { | ||
'^.+\\.js$': 'babel-jest' | ||
}, | ||
setupFiles: ['<rootDir>/setupTests.js'], | ||
snapshotSerializers: ['enzyme-to-json/serializer'] | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
{ | ||
"lerna": "2.11.0", | ||
"npmClient": "yarn", | ||
"useWorkspaces": false, | ||
"hoist": true | ||
} | ||
{ | ||
"lerna": "2.11.0", | ||
"npmClient": "yarn", | ||
"useWorkspaces": false, | ||
"hoist": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
module.exports = { | ||
useTabs: false, | ||
printWidth: 120, | ||
tabWidth: 2, | ||
singleQuote: true, | ||
trailingComma: 'none', | ||
jsxBracketSameLine: false, | ||
semi: false, | ||
write: true | ||
} | ||
module.exports = { | ||
useTabs: false, | ||
printWidth: 120, | ||
tabWidth: 2, | ||
singleQuote: true, | ||
trailingComma: 'none', | ||
jsxBracketSameLine: false, | ||
semi: false, | ||
write: true | ||
}; |
Oops, something went wrong.