xizon / uix-webpack-typescript-jest-react-scaffold

A scaffold boilerplate including TypeScript, React, Jest and ESLint.

uix-webpack-typescript-jest-react-scaffold

A scaffold boilerplate including TypeScript, React, Jest and ESLint.

File Structures

/
├── README.md
├── LICENSE
├── tsconfig.json
├── babel.config.js
├── package-lock.json
├── package.json
├── dist/
├── src/
├── test/  
├── public/  
│   ├── index.html    
│   └── assets/
├── build/  
│   └── config.js
└──

Installation And Test

You will need to have node setup on your machine. That will output the built distributables to ./dist/* .

Step 1. Use NPM (Locate your current directory of project, and enter the following command.) or download the latest version from Github. For nodejs you have to install some dependencies.

$ sudo npm install uix-webpack-typescript-jest-react-scaffold

Or clone the repo to get all source files including build scripts:

$ git clone git://github.com/xizon/uix-webpack-typescript-jest-react-scaffold.git

Step 2. First, using an absolute path into your "uix-webpack-typescript-jest-react-scaffold/" folder directory.

$ cd /{your_directory}/uix-webpack-typescript-jest-react-scaffold

Step 3. Before doing all dev stuff make sure you have Node 10+ installed. After that, run the following code in the main directory to install the node module dependencies.

$ sudo npm install

Step 4. Commonly used commands:

Debug application. It can be checked separately as TypeScript without compiling and packaging behavior.

$ npm run check

Step 5. When you’re ready to deploy to production, create a minified bundle with:

$ npm run build

Step 6. When you have done, this will spin up a server that can be accessed at

http://localhost:8080

💡 Note:

If you upgrade the version of Node, please execute the following code:

$ sudo npm install
$ sudo npm rebuild node-sass

Supported development environment

• React 17 +
• TypeScript 4.x.x +
• Babel 7.x.x +
• Webpack 5.x.x
• Jest 27.x.x

Licensing

Licensed under the MIT.